@dalmore/api-contracts 1.0.2 → 1.0.5

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 (295) hide show
  1. package/README.md +34 -55
  2. package/index.d.mts +17 -0
  3. package/index.d.ts +17 -0
  4. package/index.mjs +10970 -0
  5. package/package.json +10 -46
  6. package/common/helpers/index.ts +0 -205
  7. package/common/types/account-contact.types.ts +0 -98
  8. package/common/types/account-detail.types.ts +0 -27
  9. package/common/types/account-integration.types.ts +0 -143
  10. package/common/types/account-manager.types.ts +0 -124
  11. package/common/types/account.types.ts +0 -296
  12. package/common/types/activity.types.ts +0 -274
  13. package/common/types/address.types.ts +0 -41
  14. package/common/types/aic.types.ts +0 -246
  15. package/common/types/aml.types.ts +0 -18
  16. package/common/types/api-key-logs.types.ts +0 -66
  17. package/common/types/api-keys.types.ts +0 -69
  18. package/common/types/asset.types.ts +0 -338
  19. package/common/types/auth.types.ts +0 -370
  20. package/common/types/batch-jobs.types.ts +0 -150
  21. package/common/types/bonus-tier.types.ts +0 -147
  22. package/common/types/cart.types.ts +0 -18
  23. package/common/types/checklist-items.types.ts +0 -70
  24. package/common/types/checklist.types.ts +0 -97
  25. package/common/types/common.types.ts +0 -1520
  26. package/common/types/comply-advantage-api.types.ts +0 -316
  27. package/common/types/comply-advantage.types.ts +0 -25
  28. package/common/types/contact-us.types.ts +0 -107
  29. package/common/types/contract-helpers.ts +0 -205
  30. package/common/types/countries.types.ts +0 -375
  31. package/common/types/covered-person.types.ts +0 -274
  32. package/common/types/dashboard.types.ts +0 -799
  33. package/common/types/data-record.types.ts +0 -325
  34. package/common/types/data-room.types.ts +0 -242
  35. package/common/types/default-theme-config.types.ts +0 -87
  36. package/common/types/disbursement-adjustment.types.ts +0 -32
  37. package/common/types/disbursement-approval-user.types.ts +0 -100
  38. package/common/types/disbursement-review.types.ts +0 -110
  39. package/common/types/disbursement-transaction.types.ts +0 -72
  40. package/common/types/disbursements.types.ts +0 -310
  41. package/common/types/domain-filter.types.ts +0 -55
  42. package/common/types/email-theme.types.ts +0 -442
  43. package/common/types/entity.types.ts +0 -15
  44. package/common/types/error-responses.types.ts +0 -135
  45. package/common/types/escrow-account.types.ts +0 -104
  46. package/common/types/exchange-api-key.types.ts +0 -121
  47. package/common/types/exchange-import.types.ts +0 -36
  48. package/common/types/exchange-provider.types.ts +0 -329
  49. package/common/types/file.types.ts +0 -461
  50. package/common/types/health.types.ts +0 -29
  51. package/common/types/index.ts +0 -48
  52. package/common/types/individuals.types.ts +0 -554
  53. package/common/types/investor-account.types.ts +0 -1239
  54. package/common/types/investorAccountIdSchema.type.ts +0 -0
  55. package/common/types/investors-offering.types.ts +0 -65
  56. package/common/types/invite.types.ts +0 -133
  57. package/common/types/issuer-bank-account.types.ts +0 -107
  58. package/common/types/issuer-offering.types.ts +0 -306
  59. package/common/types/issuer-payment-method.types.ts +0 -341
  60. package/common/types/issuer.types.ts +0 -312
  61. package/common/types/job-item.types.ts +0 -119
  62. package/common/types/jobs.types.ts +0 -171
  63. package/common/types/kyb.types.ts +0 -53
  64. package/common/types/kyc.types.ts +0 -188
  65. package/common/types/legal-entity.types.ts +0 -185
  66. package/common/types/login-history.types.ts +0 -46
  67. package/common/types/mail-template.types.ts +0 -436
  68. package/common/types/north-cap-integration.types.ts +0 -190
  69. package/common/types/note.types.ts +0 -109
  70. package/common/types/notification.types.ts +0 -58
  71. package/common/types/notion-api.types.ts +0 -374
  72. package/common/types/notion-database.types.ts +0 -125
  73. package/common/types/notion-page.types.ts +0 -267
  74. package/common/types/offering-reports.types.ts +0 -153
  75. package/common/types/offering-submission.types.ts +0 -314
  76. package/common/types/offering.types.ts +0 -590
  77. package/common/types/page-revision.types.ts +0 -86
  78. package/common/types/page.types.ts +0 -436
  79. package/common/types/password.type.ts +0 -15
  80. package/common/types/payment-methods.types.ts +0 -298
  81. package/common/types/phone.type.ts +0 -27
  82. package/common/types/portfolio.types.ts +0 -50
  83. package/common/types/privacy-policy-and-tos.types.ts +0 -231
  84. package/common/types/queue.types.ts +0 -111
  85. package/common/types/registered-reps.types.ts +0 -25
  86. package/common/types/rejection-reasons.types.ts +0 -56
  87. package/common/types/review.types.ts +0 -133
  88. package/common/types/role.types.ts +0 -26
  89. package/common/types/secondary-customer.types.ts +0 -66
  90. package/common/types/secondary-issuer.types.ts +0 -50
  91. package/common/types/secondary-order.types.ts +0 -58
  92. package/common/types/secondary-security.types.ts +0 -60
  93. package/common/types/secondary-trade.entity.ts +0 -16
  94. package/common/types/secondary-trade.types.ts +0 -95
  95. package/common/types/secure-request.types.ts +0 -68
  96. package/common/types/signer.types.ts +0 -651
  97. package/common/types/site-link.types.ts +0 -166
  98. package/common/types/site-settings.types.ts +0 -726
  99. package/common/types/site.types.ts +0 -270
  100. package/common/types/sms.types.ts +0 -30
  101. package/common/types/state-machine.types.ts +0 -177
  102. package/common/types/states.types.ts +0 -163
  103. package/common/types/subdoc-preview.types.ts +0 -35
  104. package/common/types/task.types.ts +0 -258
  105. package/common/types/trade-adjustment.type.ts +0 -33
  106. package/common/types/trade-line-item.type.ts +0 -132
  107. package/common/types/trade.types.ts +0 -931
  108. package/common/types/transaction.types.ts +0 -198
  109. package/common/types/trusted-contact.types.ts +0 -122
  110. package/common/types/typography.types.ts +0 -75
  111. package/common/types/user-manual.types.ts +0 -290
  112. package/common/types/user-setting.types.ts +0 -133
  113. package/common/types/user.types.ts +0 -320
  114. package/common/types/webhook.types.ts +0 -588
  115. package/common/types/zip.type.ts +0 -36
  116. package/contracts/clients/accounts/index.ts +0 -61
  117. package/contracts/clients/aic/index.ts +0 -59
  118. package/contracts/clients/api-key-logs/index.ts +0 -53
  119. package/contracts/clients/api-keys/index.ts +0 -73
  120. package/contracts/clients/assets/index.ts +0 -102
  121. package/contracts/clients/auth/index.ts +0 -50
  122. package/contracts/clients/files/index.ts +0 -166
  123. package/contracts/clients/files-public/index.ts +0 -166
  124. package/contracts/clients/index.ts +0 -44
  125. package/contracts/clients/individuals/index.ts +0 -93
  126. package/contracts/clients/investor-accounts/index.ts +0 -93
  127. package/contracts/clients/issuers/index.ts +0 -94
  128. package/contracts/clients/legal-entities/index.ts +0 -93
  129. package/contracts/clients/offerings/index.ts +0 -117
  130. package/contracts/clients/secure-requests/index.ts +0 -34
  131. package/contracts/clients/sites/index.ts +0 -56
  132. package/contracts/clients/trades/index.ts +0 -122
  133. package/contracts/compliance/account-contacts/index.ts +0 -82
  134. package/contracts/compliance/account-managers/index.ts +0 -142
  135. package/contracts/compliance/accounts/index.ts +0 -187
  136. package/contracts/compliance/activities/index.ts +0 -55
  137. package/contracts/compliance/aic/index.ts +0 -60
  138. package/contracts/compliance/api-keys/index.ts +0 -91
  139. package/contracts/compliance/assets/index.ts +0 -122
  140. package/contracts/compliance/auth/index.ts +0 -134
  141. package/contracts/compliance/batch-jobs/index.ts +0 -62
  142. package/contracts/compliance/bonus-tiers/index.ts +0 -55
  143. package/contracts/compliance/checklist/index.ts +0 -87
  144. package/contracts/compliance/checklist-items/index.ts +0 -86
  145. package/contracts/compliance/covered-persons/index.ts +0 -97
  146. package/contracts/compliance/dashboard/index.ts +0 -111
  147. package/contracts/compliance/data-records/index.ts +0 -116
  148. package/contracts/compliance/data-rooms/index.ts +0 -113
  149. package/contracts/compliance/default-theme-configs/index.ts +0 -95
  150. package/contracts/compliance/disbursement/index.ts +0 -165
  151. package/contracts/compliance/disbursement-approval-users/index.ts +0 -84
  152. package/contracts/compliance/disbursement-transactions/index.ts +0 -37
  153. package/contracts/compliance/domain-filters/index.ts +0 -117
  154. package/contracts/compliance/email-themes/index.ts +0 -284
  155. package/contracts/compliance/escrow-accounts/index.ts +0 -85
  156. package/contracts/compliance/exchange-api-keys/index.ts +0 -129
  157. package/contracts/compliance/exchange-imports/index.ts +0 -137
  158. package/contracts/compliance/files/index.ts +0 -267
  159. package/contracts/compliance/files-public/index.ts +0 -188
  160. package/contracts/compliance/health/index.ts +0 -26
  161. package/contracts/compliance/index.ts +0 -147
  162. package/contracts/compliance/individuals/index.ts +0 -57
  163. package/contracts/compliance/investor-accounts/index.ts +0 -141
  164. package/contracts/compliance/invites/index.ts +0 -137
  165. package/contracts/compliance/issuer-bank-accounts/index.ts +0 -81
  166. package/contracts/compliance/issuer-payment-methods/index.ts +0 -81
  167. package/contracts/compliance/issuers/index.ts +0 -97
  168. package/contracts/compliance/job-items/index.ts +0 -58
  169. package/contracts/compliance/jobs/index.ts +0 -59
  170. package/contracts/compliance/kyb/index.ts +0 -54
  171. package/contracts/compliance/kyc/index.ts +0 -77
  172. package/contracts/compliance/legal-entities/index.ts +0 -57
  173. package/contracts/compliance/login-histories/index.ts +0 -37
  174. package/contracts/compliance/notes/index.ts +0 -69
  175. package/contracts/compliance/notion-databases/index.ts +0 -107
  176. package/contracts/compliance/notion-pages/index.ts +0 -105
  177. package/contracts/compliance/offering-reports/index.ts +0 -149
  178. package/contracts/compliance/offerings/index.ts +0 -233
  179. package/contracts/compliance/pages/index.ts +0 -178
  180. package/contracts/compliance/payment-methods/index.ts +0 -57
  181. package/contracts/compliance/rejection-reasons/index.ts +0 -32
  182. package/contracts/compliance/review/index.ts +0 -169
  183. package/contracts/compliance/roles/index.ts +0 -34
  184. package/contracts/compliance/secondary-customers/index.ts +0 -77
  185. package/contracts/compliance/secondary-orders/index.ts +0 -60
  186. package/contracts/compliance/secondary-trades/index.ts +0 -100
  187. package/contracts/compliance/secure-requests/index.ts +0 -54
  188. package/contracts/compliance/signer/index.ts +0 -369
  189. package/contracts/compliance/site-links/index.ts +0 -128
  190. package/contracts/compliance/site-settings/index.ts +0 -669
  191. package/contracts/compliance/sites/index.ts +0 -56
  192. package/contracts/compliance/state-machine/index.ts +0 -94
  193. package/contracts/compliance/tasks/index.ts +0 -91
  194. package/contracts/compliance/third-parties/index.ts +0 -52
  195. package/contracts/compliance/trade-line-items/index.ts +0 -59
  196. package/contracts/compliance/trades/index.ts +0 -230
  197. package/contracts/compliance/transactions/index.ts +0 -161
  198. package/contracts/compliance/user-manuals/index.ts +0 -271
  199. package/contracts/compliance/user-settings/index.ts +0 -189
  200. package/contracts/compliance/users/index.ts +0 -200
  201. package/contracts/compliance/webhooks/index.ts +0 -41
  202. package/contracts/compliance-apikey/accounts/index.ts +0 -58
  203. package/contracts/compliance-apikey/index.ts +0 -14
  204. package/contracts/index.ts +0 -6
  205. package/contracts/investors/account-contacts/index.ts +0 -58
  206. package/contracts/investors/aic/index.ts +0 -59
  207. package/contracts/investors/assets/index.ts +0 -61
  208. package/contracts/investors/auth/index.ts +0 -116
  209. package/contracts/investors/bonus-tiers/index.ts +0 -37
  210. package/contracts/investors/cart/index.ts +0 -75
  211. package/contracts/investors/contact-us/index.ts +0 -48
  212. package/contracts/investors/data-records/index.ts +0 -113
  213. package/contracts/investors/data-rooms/index.ts +0 -96
  214. package/contracts/investors/files/index.ts +0 -167
  215. package/contracts/investors/files-public/index.ts +0 -185
  216. package/contracts/investors/index.ts +0 -72
  217. package/contracts/investors/individuals/index.ts +0 -99
  218. package/contracts/investors/investor-accounts/index.ts +0 -110
  219. package/contracts/investors/issuer-payment-methods/index.ts +0 -36
  220. package/contracts/investors/issuers/index.ts +0 -30
  221. package/contracts/investors/legal-entities/index.ts +0 -93
  222. package/contracts/investors/notes/index.ts +0 -69
  223. package/contracts/investors/offerings/index.ts +0 -93
  224. package/contracts/investors/pages/index.ts +0 -88
  225. package/contracts/investors/payment-methods/index.ts +0 -149
  226. package/contracts/investors/portfolios/index.ts +0 -53
  227. package/contracts/investors/sites/index.ts +0 -96
  228. package/contracts/investors/tasks/index.ts +0 -111
  229. package/contracts/investors/trade-line-items/index.ts +0 -75
  230. package/contracts/investors/trades/index.ts +0 -114
  231. package/contracts/investors/transactions/index.ts +0 -37
  232. package/contracts/investors/trusted-contacts/index.ts +0 -93
  233. package/contracts/investors/user-manuals/index.ts +0 -62
  234. package/contracts/investors/user-settings/index.ts +0 -170
  235. package/contracts/investors/users/index.ts +0 -45
  236. package/contracts/investors/webhooks/index.ts +0 -30
  237. package/contracts/issuers/account-contacts/index.ts +0 -76
  238. package/contracts/issuers/account-integrations/index.ts +0 -97
  239. package/contracts/issuers/accounts/index.ts +0 -97
  240. package/contracts/issuers/activities/index.ts +0 -54
  241. package/contracts/issuers/aic/index.ts +0 -39
  242. package/contracts/issuers/api-key-logs/index.ts +0 -53
  243. package/contracts/issuers/api-keys/index.ts +0 -93
  244. package/contracts/issuers/assets/index.ts +0 -122
  245. package/contracts/issuers/auth/index.ts +0 -152
  246. package/contracts/issuers/bonus-tiers/index.ts +0 -55
  247. package/contracts/issuers/contact-us/index.ts +0 -48
  248. package/contracts/issuers/covered-persons/index.ts +0 -136
  249. package/contracts/issuers/dashboard/index.ts +0 -72
  250. package/contracts/issuers/data-records/index.ts +0 -257
  251. package/contracts/issuers/data-rooms/index.ts +0 -134
  252. package/contracts/issuers/disbursement-approval-users/index.ts +0 -82
  253. package/contracts/issuers/disbursement-transactions/index.ts +0 -53
  254. package/contracts/issuers/disbursements/index.ts +0 -153
  255. package/contracts/issuers/email-themes/index.ts +0 -242
  256. package/contracts/issuers/escrow-accounts/index.ts +0 -81
  257. package/contracts/issuers/exchange-api-keys/index.ts +0 -144
  258. package/contracts/issuers/files/index.ts +0 -166
  259. package/contracts/issuers/files-public/index.ts +0 -166
  260. package/contracts/issuers/health/index.ts +0 -24
  261. package/contracts/issuers/index.ts +0 -112
  262. package/contracts/issuers/investor-accounts/index.ts +0 -148
  263. package/contracts/issuers/invites/index.ts +0 -129
  264. package/contracts/issuers/issuer/index.ts +0 -94
  265. package/contracts/issuers/issuer-bank-accounts/index.ts +0 -81
  266. package/contracts/issuers/issuer-payment-methods/index.ts +0 -136
  267. package/contracts/issuers/kyc/index.ts +0 -38
  268. package/contracts/issuers/login-histories/index.ts +0 -51
  269. package/contracts/issuers/notes/index.ts +0 -69
  270. package/contracts/issuers/offerings/index.ts +0 -206
  271. package/contracts/issuers/pages/index.ts +0 -138
  272. package/contracts/issuers/payment-methods/index.ts +0 -61
  273. package/contracts/issuers/portfolios/index.ts +0 -36
  274. package/contracts/issuers/rejection-reasons/index.ts +0 -32
  275. package/contracts/issuers/review/index.ts +0 -63
  276. package/contracts/issuers/secondary-customers/index.ts +0 -55
  277. package/contracts/issuers/secondary-orders/index.ts +0 -57
  278. package/contracts/issuers/secondary-trades/index.ts +0 -57
  279. package/contracts/issuers/secure-requests/index.ts +0 -34
  280. package/contracts/issuers/site-links/index.ts +0 -116
  281. package/contracts/issuers/site-settings/index.ts +0 -585
  282. package/contracts/issuers/sites/index.ts +0 -32
  283. package/contracts/issuers/tasks/index.ts +0 -111
  284. package/contracts/issuers/trades/index.ts +0 -132
  285. package/contracts/issuers/transactions/index.ts +0 -158
  286. package/contracts/issuers/user-manuals/index.ts +0 -62
  287. package/contracts/issuers/user-settings/index.ts +0 -170
  288. package/contracts/issuers/users/index.ts +0 -126
  289. package/contracts/secondaries/accounts/index.ts +0 -58
  290. package/contracts/secondaries/index.ts +0 -23
  291. package/contracts/secondaries/secondary-customers/index.ts +0 -55
  292. package/contracts/secondaries/secondary-issuers/index.ts +0 -94
  293. package/contracts/secondaries/secondary-orders/index.ts +0 -56
  294. package/contracts/secondaries/secondary-securities/index.ts +0 -95
  295. package/contracts/secondaries/secondary-trades/index.ts +0 -56
@@ -1,325 +0,0 @@
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>;
@@ -1,242 +0,0 @@
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
- >;
@@ -1,87 +0,0 @@
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
- >;
@@ -1,32 +0,0 @@
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
- >;