@dalmore/api-contracts 1.0.5 → 1.0.6

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 (137) hide show
  1. package/package.json +4 -5
  2. package/src/common/types/account-contact.types.ts +98 -0
  3. package/src/common/types/account-detail.types.ts +27 -0
  4. package/src/common/types/account-integration.types.ts +143 -0
  5. package/src/common/types/account-manager.types.ts +124 -0
  6. package/src/common/types/account.types.ts +296 -0
  7. package/src/common/types/activity.types.ts +274 -0
  8. package/src/common/types/address.spec.ts +203 -0
  9. package/src/common/types/address.types.ts +41 -0
  10. package/src/common/types/aic.types.ts +246 -0
  11. package/src/common/types/aml.types.ts +18 -0
  12. package/src/common/types/api-key-logs.types.ts +66 -0
  13. package/src/common/types/api-keys.types.ts +69 -0
  14. package/src/common/types/asset.types.ts +338 -0
  15. package/src/common/types/auth.types.ts +370 -0
  16. package/src/common/types/batch-jobs.types.ts +151 -0
  17. package/src/common/types/bonus-tier.types.ts +147 -0
  18. package/src/common/types/cart.types.ts +18 -0
  19. package/src/common/types/checklist-items.types.ts +70 -0
  20. package/src/common/types/checklist.types.ts +97 -0
  21. package/src/common/types/common.types.spec.ts +336 -0
  22. package/src/common/types/common.types.ts +1520 -0
  23. package/src/common/types/comply-advantage-api.types.ts +316 -0
  24. package/src/common/types/comply-advantage.types.ts +25 -0
  25. package/src/common/types/contact-us.types.ts +107 -0
  26. package/src/common/types/contract-helpers.ts +205 -0
  27. package/src/common/types/countries.types.ts +375 -0
  28. package/src/common/types/covered-person.types.ts +274 -0
  29. package/src/common/types/dashboard.types.ts +799 -0
  30. package/src/common/types/data-record.types.ts +325 -0
  31. package/src/common/types/data-room.types.ts +242 -0
  32. package/src/common/types/default-theme-config.types.ts +87 -0
  33. package/src/common/types/disbursement-adjustment.types.ts +32 -0
  34. package/src/common/types/disbursement-approval-user.types.ts +100 -0
  35. package/src/common/types/disbursement-review.types.ts +110 -0
  36. package/src/common/types/disbursement-transaction.types.ts +72 -0
  37. package/src/common/types/disbursements.types.ts +310 -0
  38. package/src/common/types/domain-filter.types.ts +55 -0
  39. package/src/common/types/email-theme.types.ts +442 -0
  40. package/src/common/types/entity.types.ts +15 -0
  41. package/src/common/types/error-responses.types.ts +135 -0
  42. package/src/common/types/escrow-account.types.ts +104 -0
  43. package/src/common/types/exchange-api-key.types.ts +121 -0
  44. package/src/common/types/exchange-import.types.ts +36 -0
  45. package/src/common/types/exchange-provider.types.ts +329 -0
  46. package/src/common/types/file.types.ts +461 -0
  47. package/src/common/types/files.types.spec.ts +154 -0
  48. package/src/common/types/health.types.ts +29 -0
  49. package/src/common/types/index.ts +48 -0
  50. package/src/common/types/individuals.types.ts +554 -0
  51. package/src/common/types/investor-account.types.ts +1239 -0
  52. package/src/common/types/investorAccountIdSchema.type.ts +0 -0
  53. package/src/common/types/investors-offering.types.ts +65 -0
  54. package/src/common/types/invite.types.ts +133 -0
  55. package/src/common/types/issuer-bank-account.types.ts +107 -0
  56. package/src/common/types/issuer-offering.types.ts +306 -0
  57. package/src/common/types/issuer-payment-method.types.spec.ts +612 -0
  58. package/src/common/types/issuer-payment-method.types.ts +341 -0
  59. package/src/common/types/issuer.types.ts +312 -0
  60. package/src/common/types/job-item.types.ts +119 -0
  61. package/src/common/types/jobs.types.ts +171 -0
  62. package/src/common/types/kyb.types.ts +53 -0
  63. package/src/common/types/kyc.types.ts +188 -0
  64. package/src/common/types/legal-entity.types.ts +185 -0
  65. package/src/common/types/login-history.types.ts +46 -0
  66. package/src/common/types/mail-template.types.ts +436 -0
  67. package/src/common/types/north-cap-integration.types.ts +190 -0
  68. package/src/common/types/note.types.ts +109 -0
  69. package/src/common/types/notification.types.ts +58 -0
  70. package/src/common/types/notion-api.types.ts +374 -0
  71. package/src/common/types/notion-database.types.ts +125 -0
  72. package/src/common/types/notion-page.types.ts +267 -0
  73. package/src/common/types/offering-reports.types.ts +153 -0
  74. package/src/common/types/offering-submission.types.ts +314 -0
  75. package/src/common/types/offering.types.spec.ts +91 -0
  76. package/src/common/types/offering.types.ts +590 -0
  77. package/src/common/types/page-revision.types.ts +86 -0
  78. package/src/common/types/page.types.ts +436 -0
  79. package/src/common/types/password.type.ts +15 -0
  80. package/src/common/types/payment-methods.types.ts +298 -0
  81. package/src/common/types/phone.spec.ts +76 -0
  82. package/src/common/types/phone.type.ts +27 -0
  83. package/src/common/types/portfolio.types.ts +50 -0
  84. package/src/common/types/privacy-policy-and-tos.types.ts +231 -0
  85. package/src/common/types/queue.types.ts +112 -0
  86. package/src/common/types/registered-reps.types.ts +25 -0
  87. package/src/common/types/rejection-reasons.types.ts +56 -0
  88. package/src/common/types/reminder-config.types.ts +40 -0
  89. package/src/common/types/review.types.ts +133 -0
  90. package/src/common/types/role.types.ts +26 -0
  91. package/src/common/types/secondary-customer.types.ts +66 -0
  92. package/src/common/types/secondary-issuer.types.ts +50 -0
  93. package/src/common/types/secondary-order.types.ts +58 -0
  94. package/src/common/types/secondary-security.types.ts +60 -0
  95. package/src/common/types/secondary-trade.entity.ts +16 -0
  96. package/src/common/types/secondary-trade.types.ts +95 -0
  97. package/src/common/types/secure-request.types.ts +68 -0
  98. package/src/common/types/signer.types.ts +651 -0
  99. package/src/common/types/site-link.types.spec.ts +134 -0
  100. package/src/common/types/site-link.types.ts +166 -0
  101. package/src/common/types/site-settings.types.ts +726 -0
  102. package/src/common/types/site.types.ts +270 -0
  103. package/src/common/types/sms.types.ts +30 -0
  104. package/src/common/types/state-machine.types.ts +177 -0
  105. package/src/common/types/states.types.ts +163 -0
  106. package/src/common/types/subdoc-preview.types.ts +35 -0
  107. package/src/common/types/task.types.ts +258 -0
  108. package/src/common/types/trade-adjustment.type.ts +33 -0
  109. package/src/common/types/trade-line-item.type.ts +132 -0
  110. package/src/common/types/trade.types.ts +929 -0
  111. package/src/common/types/transaction.types.ts +198 -0
  112. package/src/common/types/trusted-contact.types.ts +122 -0
  113. package/src/common/types/typography.types.ts +75 -0
  114. package/src/common/types/user-manual.types.ts +290 -0
  115. package/src/common/types/user-setting.types.ts +133 -0
  116. package/src/common/types/user.types.ts +320 -0
  117. package/src/common/types/webhook.types.ts +588 -0
  118. package/src/common/types/zip.type.ts +36 -0
  119. package/src/contracts/clients/accounts/index.ts +61 -0
  120. package/src/contracts/clients/aic/index.ts +59 -0
  121. package/src/contracts/clients/api-key-logs/index.ts +53 -0
  122. package/src/contracts/clients/api-keys/index.ts +73 -0
  123. package/src/contracts/clients/assets/index.ts +102 -0
  124. package/src/contracts/clients/auth/index.ts +50 -0
  125. package/src/contracts/clients/files/index.ts +166 -0
  126. package/src/contracts/clients/files-public/index.ts +166 -0
  127. package/src/contracts/clients/index.ts +44 -0
  128. package/src/contracts/clients/individuals/index.ts +93 -0
  129. package/src/contracts/clients/investor-accounts/index.ts +93 -0
  130. package/src/contracts/clients/issuers/index.ts +94 -0
  131. package/src/contracts/clients/legal-entities/index.ts +93 -0
  132. package/src/contracts/clients/offerings/index.ts +117 -0
  133. package/src/contracts/clients/secure-requests/index.ts +34 -0
  134. package/src/contracts/clients/sites/index.ts +56 -0
  135. package/src/contracts/clients/trades/index.ts +122 -0
  136. package/index.d.mts +0 -17
  137. package/index.d.ts +0 -17
@@ -0,0 +1,325 @@
1
+ import { z } from 'zod';
2
+ import { TypeID } from 'typeid-js';
3
+ import { IBaseEntity } from './entity.types';
4
+ import { dataRoomIdSchema } from './data-room.types';
5
+ import { fileIdSchema } from './file.types';
6
+ import { BaseStatus, IPaginationMeta } from './common.types';
7
+ import { extendZodWithOpenApi } from '@anatine/zod-openapi';
8
+ extendZodWithOpenApi(z);
9
+
10
+ export const dataRecordIdSchema = z.string().refine(
11
+ (value) => {
12
+ try {
13
+ const tid = TypeID.fromString(value);
14
+ return tid.getType() === 'data_record';
15
+ } catch {
16
+ return false;
17
+ }
18
+ },
19
+ {
20
+ message:
21
+ 'Invalid data_record ID format. Must be a valid TypeID with "data_record" prefix.',
22
+ },
23
+ );
24
+
25
+ export const dataRecordFileIdSchema = z.string().refine(
26
+ (value) => {
27
+ try {
28
+ const tid = TypeID.fromString(value);
29
+ return tid.getType() === 'data_record_file';
30
+ } catch {
31
+ return false;
32
+ }
33
+ },
34
+ {
35
+ message:
36
+ 'Invalid data_record_file ID format. Must be a valid TypeID with "data_record" prefix.',
37
+ },
38
+ );
39
+
40
+ const dataRecordsInclude = z.enum(['dataRecordFiles', 'children']);
41
+
42
+ /**
43
+ * @description Query parameters for including related entities
44
+ * @example in contract us as -> query: z.object({}).merge(DataRecordsIncludeQuery),
45
+ */
46
+ export const DataRecordsIncludeQuery = z.object({
47
+ include: z
48
+ .string()
49
+ .optional()
50
+ .transform((str) => (str ? str.split(',') : []))
51
+ .refine(
52
+ (includes) =>
53
+ includes.every((include) =>
54
+ dataRecordsInclude.options.includes(include as any),
55
+ ),
56
+ {
57
+ message: `Invalid include option provided. Valid options are: ${dataRecordsInclude.options.join(',')}`,
58
+ },
59
+ )
60
+ .openapi({
61
+ example: `${dataRecordsInclude.options.join(',')}`,
62
+ }),
63
+ });
64
+ export interface DataRecordsIncludeQuery
65
+ extends z.infer<typeof DataRecordsIncludeQuery> {}
66
+
67
+ export const DataRecordFileZod = IBaseEntity.extend({
68
+ dataRecordId: z.lazy(() => dataRecordIdSchema),
69
+ fileId: fileIdSchema.nullable(),
70
+ });
71
+ export type DataRecordFileZod = z.infer<typeof DataRecordFileZod>;
72
+
73
+ export enum DataRecordType {
74
+ FOLDER = 'FOLDER',
75
+ }
76
+
77
+ export const DataRecordZod = IBaseEntity.extend({
78
+ name: z.string(),
79
+ type: z.nativeEnum(DataRecordType),
80
+ parentId: z.string().nullable(),
81
+ children: z.array(z.lazy(() => DataRecordZod)).openapi({
82
+ example: [
83
+ {
84
+ id: 'data_record_01jghnncbmfkpre0ybqv0n8017',
85
+ name: 'Record 1',
86
+ type: 'FOLDER',
87
+ parentId: 'data_record_01jghnncbmfkpre0ybqv0n8017',
88
+ children: [],
89
+ dataRecordFiles: [],
90
+ dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
91
+ },
92
+ ],
93
+ }),
94
+ dataRecordFiles: z.array(DataRecordFileZod),
95
+ dataRoomId: z.lazy(() => dataRoomIdSchema),
96
+ });
97
+ export type DataRecordZod = z.infer<typeof DataRecordZod>;
98
+
99
+ export const IPaginatedDataRecords = z.object({
100
+ items: z.array(DataRecordZod),
101
+ meta: IPaginationMeta,
102
+ });
103
+ export type IPaginatedDataRecords = z.infer<typeof IPaginatedDataRecords>;
104
+
105
+ export const RecordPathResponse = z.object({
106
+ records: z.array(DataRecordZod),
107
+ path: z.string().openapi({ example: '/folder_1/folder_2/target_record' }),
108
+ });
109
+ export type RecordPathResponse = z.infer<typeof RecordPathResponse>;
110
+
111
+ export const PostDataRecordFolder = z.object({
112
+ name: z.string().min(1).max(255),
113
+ dataRoomId: z.lazy(() => dataRoomIdSchema),
114
+ parentId: dataRecordIdSchema,
115
+ });
116
+ export type PostDataRecordFolder = z.infer<typeof PostDataRecordFolder>;
117
+
118
+ export const DeleteDataRecordFolder = z.object({
119
+ folderId: dataRecordIdSchema,
120
+ force: z.boolean().default(false),
121
+ });
122
+ export type DeleteDataRecordFolder = z.infer<typeof DeleteDataRecordFolder>;
123
+
124
+ export const MoveDataRecordFolder = z.object({
125
+ folderId: dataRecordIdSchema,
126
+ targetFolderId: dataRecordIdSchema,
127
+ });
128
+ export type MoveDataRecordFolder = z.infer<typeof MoveDataRecordFolder>;
129
+
130
+ export const PostDataRecordFile = z.object({
131
+ dataRecordId: dataRecordIdSchema,
132
+ });
133
+ export type PostDataRecordFile = z.infer<typeof PostDataRecordFile>;
134
+
135
+ export const PatchDataRecordFile = z.object({
136
+ fileId: fileIdSchema,
137
+ });
138
+ export type PatchDataRecordFile = z.infer<typeof PatchDataRecordFile>;
139
+
140
+ export const DeleteDataRecordFile = z.object({
141
+ dataRecordId: dataRecordIdSchema,
142
+ fileId: fileIdSchema,
143
+ });
144
+ export type DeleteDataRecordFile = z.infer<typeof DeleteDataRecordFile>;
145
+
146
+ export const MoveDataRecordFile = z.object({
147
+ sourceFolderId: dataRecordIdSchema,
148
+ targetFolderId: dataRecordIdSchema,
149
+ fileId: fileIdSchema,
150
+ });
151
+ export type MoveDataRecordFile = z.infer<typeof MoveDataRecordFile>;
152
+
153
+ export const PatchDataRecordFolder = z.object({
154
+ name: z.string().min(1).max(255),
155
+ });
156
+ export type PatchDataRecordFolder = z.infer<typeof PatchDataRecordFolder>;
157
+
158
+ type IBaseEntityType = z.infer<typeof IBaseEntity>;
159
+
160
+ export interface BaseDataRecordStructure extends IBaseEntityType {
161
+ name: string;
162
+ type: DataRecordType;
163
+ parentId: string | null;
164
+ dataRoomId: string;
165
+ dataRecordFiles?: DataRecordFileZod[] | undefined;
166
+ data?: BaseDataRecordStructure[] | undefined;
167
+ }
168
+
169
+ export const DataRecordStructureZod: z.ZodType<BaseDataRecordStructure> = z
170
+ .lazy(() =>
171
+ IBaseEntity.extend({
172
+ name: z.string().min(1).max(255),
173
+ type: z.nativeEnum(DataRecordType),
174
+ parentId: z.string().nullable(),
175
+ dataRoomId: z.string(),
176
+ dataRecordFiles: z.array(DataRecordFileZod).optional(),
177
+ data: z.array(z.lazy(() => DataRecordStructureZod)).optional(),
178
+ isPasswordProtected: z.boolean(),
179
+ }),
180
+ )
181
+ .openapi({
182
+ example: {
183
+ createdAt: '2025-01-01T19:31:04.725Z',
184
+ updatedAt: '2025-01-01T19:50:28.979Z',
185
+ deletedAt: null,
186
+ id: 'data_record_01jghnk8wxeb6sc3aqphtdjk9e',
187
+ name: 'Folder 1 Updated',
188
+ type: 'FOLDER',
189
+ parentId: null,
190
+ dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
191
+ dataRecordFiles: [
192
+ {
193
+ createdAt: '2025-01-01T21:55:45.048Z',
194
+ updatedAt: '2025-01-01T21:55:45.048Z',
195
+ deletedAt: null,
196
+ id: 'data_record_file_01jghxw5ryfrev868psy5m2kkd',
197
+ dataRecordId: 'data_record_01jghnk8wxeb6sc3aqphtdjk9e',
198
+ fileId: 'file_01jghxv0eae8rttq5rw2arry34',
199
+ file: {
200
+ createdAt: '2025-01-01T21:55:06.528Z',
201
+ updatedAt: '2025-01-01T21:55:06.528Z',
202
+ deletedAt: null,
203
+ id: 'file_01jghxv0eae8rttq5rw2arry34',
204
+ tid: null,
205
+ url: 'https://dalmoredatafactory.blob.core.windows.net/api-files-public-dev/1735768506533.trade_01jghn5866f3ev3xe7a82ykqbn.test.pdf',
206
+ fileType: 'application/pdf',
207
+ fileName: 'test.pdf',
208
+ name: 'test',
209
+ category: 'test',
210
+ label: 'label',
211
+ extractedData: null,
212
+ targetTable: 'TRADES',
213
+ targetId: 'trade_01jghn5866f3ev3xe7a82ykqbn',
214
+ linkedFrom: null,
215
+ accountId: 'account_01jghn57a5e0wvz5q4t9a9fzj5',
216
+ userId: 'user_01jghn57pgfpsvqczcvz6pmv50',
217
+ __entity: 'File',
218
+ },
219
+ __entity: 'DataRecordFile',
220
+ },
221
+ ],
222
+ __entity: 'DataRecord',
223
+ data: [
224
+ {
225
+ createdAt: '2025-01-01T19:32:13.779Z',
226
+ updatedAt: '2025-01-01T19:32:13.779Z',
227
+ deletedAt: null,
228
+ id: 'data_record_01jghnncbmfkpre0ybqv0n8017',
229
+ name: 'Folder 1.1',
230
+ type: 'FOLDER',
231
+ parentId: 'data_record_01jghnk8wxeb6sc3aqphtdjk9e',
232
+ dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
233
+ dataRecordFiles: [],
234
+ __entity: 'DataRecord',
235
+ data: [
236
+ {
237
+ createdAt: '2025-01-01T20:42:54.458Z',
238
+ updatedAt: '2025-01-01T20:42:54.458Z',
239
+ deletedAt: null,
240
+ id: 'data_record_01jghspsmgff8a6sjc7b78s1dx',
241
+ name: 'Folder 1.2',
242
+ type: 'FOLDER',
243
+ parentId: 'data_record_01jghnncbmfkpre0ybqv0n8017',
244
+ dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
245
+ dataRecordFiles: [],
246
+ __entity: 'DataRecord',
247
+ data: [],
248
+ },
249
+ ],
250
+ },
251
+ ],
252
+ },
253
+ });
254
+ export type DataRecordStructureZod = z.infer<typeof DataRecordStructureZod>;
255
+
256
+ export const DataRecordsFilters = z.object({
257
+ search: z.string().max(50).optional(),
258
+ parentId: dataRecordIdSchema.optional(),
259
+ dataRoomId: z.lazy(() => dataRoomIdSchema).optional(),
260
+ status: z.nativeEnum(BaseStatus).optional(),
261
+ });
262
+ export type DataRecordsFilters = z.infer<typeof DataRecordsFilters>;
263
+
264
+ export const FolderSummaryZod = DataRecordZod.extend({
265
+ childCount: z.number(),
266
+ fileCount: z.number(),
267
+ descendantCount: z.number(),
268
+ });
269
+ export type FolderSummaryZod = z.infer<typeof FolderSummaryZod>;
270
+
271
+ export const NavigationContextZod = z.object({
272
+ isRoot: z.boolean(),
273
+ depth: z.number(),
274
+ hasChildren: z.boolean(),
275
+ currentPath: z.string(),
276
+ parentPath: z.string(),
277
+ context: z.object({
278
+ dataRoomName: z.string(),
279
+ currentFolderName: z.string(),
280
+ parentFolderName: z.string().nullable(),
281
+ }),
282
+ });
283
+ export type NavigationContextZod = z.infer<typeof NavigationContextZod>;
284
+
285
+ export const NavigationSummaryZod = z
286
+ .object({
287
+ currentFolder: FolderSummaryZod,
288
+ parentFolder: FolderSummaryZod.nullable(),
289
+ siblings: z.array(FolderSummaryZod),
290
+ children: z.array(FolderSummaryZod),
291
+ totalDescendants: z.number(),
292
+ navigation: NavigationContextZod,
293
+ })
294
+ .openapi({
295
+ example: {
296
+ currentFolder: {
297
+ id: 'data_record_01jgjdkne6fbf9bwerypvkd2b5',
298
+ name: 'Folder 1',
299
+ type: 'FOLDER',
300
+ parentId: null,
301
+ dataRoomId: 'data_room_01jgjdk1zse759qsb8ma5w9q42',
302
+ childCount: 2,
303
+ fileCount: 0,
304
+ descendantCount: 3,
305
+ dataRecordFiles: [],
306
+ },
307
+ parentFolder: null,
308
+ siblings: [],
309
+ children: [],
310
+ totalDescendants: 3,
311
+ navigation: {
312
+ isRoot: true,
313
+ depth: 0,
314
+ hasChildren: true,
315
+ currentPath: 'Folder 1',
316
+ parentPath: '',
317
+ context: {
318
+ dataRoomName: 'Test Data Room',
319
+ currentFolderName: 'Folder 1',
320
+ parentFolderName: null,
321
+ },
322
+ },
323
+ },
324
+ });
325
+ export type NavigationSummaryZod = z.infer<typeof NavigationSummaryZod>;
@@ -0,0 +1,242 @@
1
+ import { z } from 'zod';
2
+ import {
3
+ AccountZod,
4
+ ComplianceReview,
5
+ IPaginationMeta,
6
+ PaginationOptionsZod,
7
+ UrlSchema,
8
+ } from './common.types';
9
+ import { TypeID } from 'typeid-js';
10
+ import { accountIdSchema } from './account.types';
11
+ import { IBaseEntity } from './entity.types';
12
+ import { DataRecordStructureZod, DataRecordZod } from './data-record.types';
13
+ import { extendZodWithOpenApi } from '@anatine/zod-openapi';
14
+ import { PasswordSchema } from './password.type';
15
+ extendZodWithOpenApi(z);
16
+
17
+ export const dataRoomIdSchema = z.string().refine(
18
+ (value) => {
19
+ try {
20
+ const tid = TypeID.fromString(value);
21
+ return tid.getType() === 'data_room';
22
+ } catch {
23
+ return false;
24
+ }
25
+ },
26
+ {
27
+ message:
28
+ 'Invalid data_room ID format. Must be a valid TypeID with "data_room" prefix.',
29
+ },
30
+ );
31
+
32
+ const dataRoomsInclude = z.enum(['dataRecords', 'account']);
33
+
34
+ /**
35
+ * @description Query parameters for including related entities
36
+ * @example in contract us as -> query: z.object({}).merge(DataRoomsIncludeQuery),
37
+ */
38
+ export const DataRoomsIncludeQuery = z.object({
39
+ include: z
40
+ .string()
41
+ .optional()
42
+ .transform((str) => (str ? str.split(',') : []))
43
+ .refine(
44
+ (includes) =>
45
+ includes.every((include) =>
46
+ dataRoomsInclude.options.includes(include as any),
47
+ ),
48
+ {
49
+ message: `Invalid include option provided. Valid options are: ${dataRoomsInclude.options.join(',')}`,
50
+ },
51
+ )
52
+ .openapi({
53
+ example: `${dataRoomsInclude.options.join(',')}`,
54
+ }),
55
+ });
56
+ export interface DataRoomsIncludeQuery
57
+ extends z.infer<typeof DataRoomsIncludeQuery> {}
58
+
59
+ export const DataRoomZod = IBaseEntity.extend({
60
+ name: z.string(),
61
+ accountId: accountIdSchema,
62
+ account: AccountZod.optional().nullable(),
63
+ dataRecords: z.array(z.lazy(() => DataRecordZod)).openapi({
64
+ example: [
65
+ {
66
+ id: 'data_record_01jghnncbmfkpre0ybqv0n8017',
67
+ name: 'Record 1',
68
+ type: 'FOLDER',
69
+ parentId: null,
70
+ children: [],
71
+ dataRecordFiles: [],
72
+ dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
73
+ },
74
+ ],
75
+ }),
76
+ });
77
+ export type DataRoomZod = z.infer<typeof DataRoomZod>;
78
+
79
+ export const IPaginatedDataRooms = z.object({
80
+ items: z.array(DataRoomZod),
81
+ meta: IPaginationMeta,
82
+ });
83
+ export type IPaginatedDataRooms = z.infer<typeof IPaginatedDataRooms>;
84
+
85
+ export const DataRoomApprovalsZod = z.object({
86
+ accountName: z.string(),
87
+ accountId: accountIdSchema,
88
+ pendingFilesCount: z.number(),
89
+ });
90
+ export type DataRoomApprovalsZod = z.infer<typeof DataRoomApprovalsZod>;
91
+
92
+ export const PostDataRoom = z.object({
93
+ name: z.string().min(2).max(50),
94
+ });
95
+ export type PostDataRoom = z.infer<typeof PostDataRoom>;
96
+
97
+ export const DeleteDataRoom = z.object({
98
+ dataRoomId: dataRoomIdSchema,
99
+ force: z.boolean().default(false),
100
+ });
101
+ export type DeleteDataRoom = z.infer<typeof DeleteDataRoom>;
102
+
103
+ export const DataRoomsFilters = z.object({
104
+ search: z.string().max(50).optional(),
105
+ accountId: accountIdSchema.optional(),
106
+ });
107
+ export type DataRoomsFilters = z.infer<typeof DataRoomsFilters>;
108
+
109
+ export const InvestorDataRoomsFilters = DataRoomsFilters.omit({
110
+ accountId: true,
111
+ });
112
+ export type InvestorDataRoomsFilters = z.infer<typeof InvestorDataRoomsFilters>;
113
+
114
+ export const DataRoomStructureZod = IBaseEntity.extend({
115
+ name: z.string().min(1).max(255),
116
+ accountId: accountIdSchema,
117
+ dataRecords: z.array(DataRecordStructureZod).openapi({
118
+ example: [
119
+ {
120
+ id: 'data_record_01jghnncbmfkpre0ybqv0n8017',
121
+ name: 'Record 1',
122
+ type: 'FOLDER',
123
+ parentId: null,
124
+ dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
125
+ data: [
126
+ {
127
+ id: 'data_record_01jghnncbmfkpre0ybqv0n53322',
128
+ name: 'Record 2',
129
+ type: 'FOLDER',
130
+ parentId: 'data_record_01jghnncbmfkpre0ybqv0n8017',
131
+ dataRoomId: 'data_room_01jghn6n7mep5a5q0t60ndzya6',
132
+ data: [],
133
+ },
134
+ ],
135
+ },
136
+ ],
137
+ }),
138
+ isPasswordProtected: z.boolean(),
139
+ });
140
+ export type DataRoomStructureZod = z.infer<typeof DataRoomStructureZod>;
141
+
142
+ export const DataRoomFilesSummaryFilterZod = z.object({
143
+ accountId: accountIdSchema.optional(),
144
+ status: z.nativeEnum(ComplianceReview),
145
+ });
146
+
147
+ export type DataRoomFilesSummaryFilterZod = z.infer<
148
+ typeof DataRoomFilesSummaryFilterZod
149
+ >;
150
+
151
+ export const DataRoomFileSummary = z.object({
152
+ fileId: z.string(),
153
+ fileName: z.string(),
154
+ fileType: z.string(),
155
+ complianceReview: z.nativeEnum(ComplianceReview),
156
+ account: z.object({
157
+ id: z.string(),
158
+ name: z.string(),
159
+ }),
160
+ dataRoom: z.object({
161
+ id: z.string(),
162
+ name: z.string(),
163
+ }),
164
+ structure: z.object({
165
+ path: z.string(),
166
+ }),
167
+ createdAt: z.date(),
168
+ updatedAt: z.date(),
169
+ });
170
+
171
+ export type DataRoomFileSummary = z.infer<typeof DataRoomFileSummary>;
172
+
173
+ export const IPaginatedDataRoomFilesSummaryZod = z.object({
174
+ items: z.array(DataRoomFileSummary),
175
+ meta: IPaginationMeta,
176
+ });
177
+ export type IPaginatedDataRoomFilesSummaryZod = z.infer<
178
+ typeof IPaginatedDataRoomFilesSummaryZod
179
+ >;
180
+
181
+ export const DataRoomsQueryZod = PaginationOptionsZod.and(DataRoomsFilters).and(
182
+ DataRoomsIncludeQuery,
183
+ );
184
+
185
+ export type DataRoomsQueryZod = z.infer<typeof DataRoomsQueryZod>;
186
+
187
+ export const PublicDataRoomFiltersZod = PaginationOptionsZod.merge(
188
+ DataRoomsFilters,
189
+ )
190
+ .merge(DataRoomsIncludeQuery)
191
+ .extend({
192
+ url: UrlSchema,
193
+ });
194
+
195
+ export type PublicDataRoomFiltersZod = z.infer<typeof PublicDataRoomFiltersZod>;
196
+
197
+ export const PatchDataRoomZod = PostDataRoom.extend({
198
+ isPasswordProtected: z.boolean().optional(),
199
+ password: PasswordSchema.optional(),
200
+ }).refine(
201
+ (data) => {
202
+ if (data.isPasswordProtected) {
203
+ return data.password !== undefined;
204
+ }
205
+ return true;
206
+ },
207
+ {
208
+ message: 'Password is required when password protection is enabled',
209
+ path: ['password'],
210
+ },
211
+ );
212
+ export type PatchDataRoomZod = z.infer<typeof PatchDataRoomZod>;
213
+
214
+ export const DataRoomPasswordQueryZod = z.object({
215
+ password: z.string().min(6).optional().openapi({
216
+ example: 'Secretpassword6#',
217
+ }),
218
+ });
219
+ export type DataRoomPasswordQueryZod = z.infer<typeof DataRoomPasswordQueryZod>;
220
+
221
+ export const GetDataRoomQueryZod = DataRoomsIncludeQuery.merge(
222
+ DataRoomPasswordQueryZod,
223
+ );
224
+ export type GetDataRoomQueryZod = z.infer<typeof GetDataRoomQueryZod>;
225
+
226
+ export const DataRoomZodWithoutPassword = IBaseEntity.extend({
227
+ name: z.string(),
228
+ accountId: accountIdSchema,
229
+ account: AccountZod.optional().nullable(),
230
+ dataRecords: z.array(z.any()).optional().nullable(),
231
+ isPasswordProtected: z.boolean(),
232
+ });
233
+ export type DataRoomZodWithoutPassword = z.infer<
234
+ typeof DataRoomZodWithoutPassword
235
+ >;
236
+ export const IPaginatedDataRoomsWithoutPassword = z.object({
237
+ items: z.array(DataRoomZodWithoutPassword),
238
+ meta: IPaginationMeta,
239
+ });
240
+ export type IPaginatedDataRoomsWithoutPassword = z.infer<
241
+ typeof IPaginatedDataRoomsWithoutPassword
242
+ >;
@@ -0,0 +1,87 @@
1
+ import { extendZodWithOpenApi } from '@anatine/zod-openapi';
2
+ import { TypeID } from 'typeid-js';
3
+ import { z } from 'zod';
4
+ import { IPaginationMeta } from './common.types';
5
+ import { ITheme, themeIdSchema } from './site-settings.types';
6
+ import { emailThemeIdSchema, IEmailTheme } from './email-theme.types';
7
+ import { IBaseEntity } from './entity.types';
8
+
9
+ extendZodWithOpenApi(z);
10
+
11
+ export const defaultThemeConfigIdSchema = z.string().refine(
12
+ (value) => {
13
+ try {
14
+ const tid = TypeID.fromString(value);
15
+ return tid.getType() === 'default_theme_config';
16
+ } catch {
17
+ return false;
18
+ }
19
+ },
20
+ {
21
+ message: `Invalid default theme config ID format. Must be a valid TypeID with "default_theme_config" prefix. Example: default_theme_config_01j5y5ghx5fg68d663j1fvy2x7`,
22
+ },
23
+ );
24
+
25
+ export const IDefaultThemeConfig = IBaseEntity.extend({
26
+ id: defaultThemeConfigIdSchema,
27
+ name: z.string().nullable(),
28
+ themeId: z.lazy(() => themeIdSchema),
29
+ theme: z
30
+ .lazy(() => ITheme)
31
+ .nullable()
32
+ .optional(),
33
+ emailThemeId: z.lazy(() => emailThemeIdSchema),
34
+ emailTheme: z
35
+ .lazy(() => IEmailTheme)
36
+ .nullable()
37
+ .optional(),
38
+ enabled: z.boolean(),
39
+ });
40
+
41
+ export type IDefaultThemeConfig = z.infer<typeof IDefaultThemeConfig>;
42
+
43
+ export const GetDefaultThemeConfig = z.object({
44
+ id: defaultThemeConfigIdSchema,
45
+ name: z.string().nullable(),
46
+ siteThemeName: z.string().nullable(),
47
+ siteThemeId: z.string(),
48
+ emailThemeName: z.string().nullable(),
49
+ emailThemeId: z.string(),
50
+ enabled: z.boolean(),
51
+ primaryColor: z.string().nullable(),
52
+ primaryTextColor: z.string().nullable(),
53
+ secondaryColor: z.string().nullable(),
54
+ secondaryTextColor: z.string().nullable(),
55
+ });
56
+
57
+ export type GetDefaultThemeConfig = z.infer<typeof GetDefaultThemeConfig>;
58
+
59
+ export const IPaginatedDefaultThemeConfigsZod = z.object({
60
+ items: z.array(GetDefaultThemeConfig),
61
+ meta: IPaginationMeta,
62
+ });
63
+
64
+ export type IPaginatedDefaultThemeConfigsZod = z.infer<
65
+ typeof IPaginatedDefaultThemeConfigsZod
66
+ >;
67
+
68
+ export const PostDefaultThemeConfigZod = z.object({
69
+ name: z.string().min(1).max(60),
70
+ siteThemeId: z.lazy(() => themeIdSchema),
71
+ emailThemeId: z.lazy(() => emailThemeIdSchema),
72
+ });
73
+
74
+ export type PostDefaultThemeConfigZod = z.infer<
75
+ typeof PostDefaultThemeConfigZod
76
+ >;
77
+
78
+ export const PatchDefaultThemeConfigZod = z.object({
79
+ name: z.string().min(1).max(60).optional(),
80
+ themeId: z.lazy(() => themeIdSchema).optional(),
81
+ emailThemeId: z.lazy(() => emailThemeIdSchema).optional(),
82
+ enabled: z.boolean().optional(),
83
+ });
84
+
85
+ export type PatchDefaultThemeConfigZod = z.infer<
86
+ typeof PatchDefaultThemeConfigZod
87
+ >;
@@ -0,0 +1,32 @@
1
+ import { TypeID } from 'typeid-js';
2
+ import { z } from 'zod';
3
+
4
+ export const disbursementAdjustmentIdSchema = z.string().refine(
5
+ (value) => {
6
+ try {
7
+ const tid = TypeID.fromString(value);
8
+ return tid.getType() === 'disbursement_adjustment';
9
+ } catch {
10
+ return false;
11
+ }
12
+ },
13
+ {
14
+ message:
15
+ 'Invalid disbursement adjustment ID format. Must be a valid TypeID with "disbursement_adjustment" prefix.',
16
+ },
17
+ );
18
+
19
+ export enum DisbursementAdjustmentType {
20
+ COMISSION = 'COMISSION',
21
+ DISBURSEMENT_FEE = 'DISBURSEMENT_FEE',
22
+ REFUND_POOL = 'REFUND_POOL',
23
+ }
24
+
25
+ export const PostDisbursementAdjustmentZod = z.object({
26
+ type: z.nativeEnum(DisbursementAdjustmentType),
27
+ value: z.number().max(10000000000),
28
+ description: z.string().max(50),
29
+ });
30
+ export type PostDisbursementAdjustmentZod = z.infer<
31
+ typeof PostDisbursementAdjustmentZod
32
+ >;