@sachfolio/cas-reader 0.0.0-stage → 0.2.0-beta.1

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 (84) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/LICENSE +71 -0
  3. package/NOTICE +41 -0
  4. package/README.md +198 -2
  5. package/dist/analytics/contract.d.ts +110 -0
  6. package/dist/analytics/contract.js +79 -0
  7. package/dist/analytics/eligibility.d.ts +66 -0
  8. package/dist/analytics/eligibility.js +93 -0
  9. package/dist/analytics/gains-schema.d.ts +898 -0
  10. package/dist/analytics/gains-schema.js +170 -0
  11. package/dist/analytics/gains.d.ts +319 -0
  12. package/dist/analytics/gains.js +649 -0
  13. package/dist/analytics/modules.d.ts +33 -0
  14. package/dist/analytics/modules.js +74 -0
  15. package/dist/analytics/returns-schema.d.ts +931 -0
  16. package/dist/analytics/returns-schema.js +152 -0
  17. package/dist/analytics/returns.d.ts +126 -0
  18. package/dist/analytics/returns.js +453 -0
  19. package/dist/analytics/schedule112a.d.ts +77 -0
  20. package/dist/analytics/schedule112a.js +134 -0
  21. package/dist/analytics/xirr.d.ts +75 -0
  22. package/dist/analytics/xirr.js +314 -0
  23. package/dist/bin/cas.d.ts +2 -0
  24. package/dist/bin/cas.js +137 -0
  25. package/dist/checks.d.ts +49 -0
  26. package/dist/checks.js +227 -0
  27. package/dist/compat/casparser.d.ts +121 -0
  28. package/dist/compat/casparser.js +193 -0
  29. package/dist/detect.d.ts +10 -0
  30. package/dist/detect.js +69 -0
  31. package/dist/errors.d.ts +26 -0
  32. package/dist/errors.js +95 -0
  33. package/dist/export/csv.d.ts +21 -0
  34. package/dist/export/csv.js +49 -0
  35. package/dist/extract/browser.d.ts +17 -0
  36. package/dist/extract/browser.js +34 -0
  37. package/dist/extract/budget.d.ts +46 -0
  38. package/dist/extract/budget.js +88 -0
  39. package/dist/extract/node.d.ts +11 -0
  40. package/dist/extract/node.js +31 -0
  41. package/dist/extract/pdfjs.d.ts +71 -0
  42. package/dist/extract/pdfjs.js +244 -0
  43. package/dist/extract/types.d.ts +106 -0
  44. package/dist/extract/types.js +11 -0
  45. package/dist/index.d.ts +27 -0
  46. package/dist/index.js +26 -0
  47. package/dist/layout/lines.d.ts +51 -0
  48. package/dist/layout/lines.js +115 -0
  49. package/dist/licence/app-licence.d.ts +53 -0
  50. package/dist/licence/app-licence.js +139 -0
  51. package/dist/licence/ed25519.d.ts +2 -0
  52. package/dist/licence/ed25519.js +103 -0
  53. package/dist/model.d.ts +148 -0
  54. package/dist/model.js +1 -0
  55. package/dist/num.d.ts +19 -0
  56. package/dist/num.js +27 -0
  57. package/dist/parse.d.ts +4 -0
  58. package/dist/parse.js +13 -0
  59. package/dist/parsers/cams/classify.d.ts +25 -0
  60. package/dist/parsers/cams/classify.js +103 -0
  61. package/dist/parsers/cams/detailed.d.ts +15 -0
  62. package/dist/parsers/cams/detailed.js +343 -0
  63. package/dist/parsers/cams/header.d.ts +47 -0
  64. package/dist/parsers/cams/header.js +170 -0
  65. package/dist/parsers/cams/investor.d.ts +28 -0
  66. package/dist/parsers/cams/investor.js +139 -0
  67. package/dist/parsers/cams/summary.d.ts +29 -0
  68. package/dist/parsers/cams/summary.js +413 -0
  69. package/dist/parsers/cams/table.d.ts +55 -0
  70. package/dist/parsers/cams/table.js +144 -0
  71. package/dist/parsers/cams/total.d.ts +17 -0
  72. package/dist/parsers/cams/total.js +105 -0
  73. package/dist/parsers/depository/mf.d.ts +22 -0
  74. package/dist/parsers/depository/mf.js +438 -0
  75. package/dist/privacy.d.ts +243 -0
  76. package/dist/privacy.js +256 -0
  77. package/dist/schema.d.ts +779 -0
  78. package/dist/schema.js +214 -0
  79. package/examples/nextjs/app/page.jsx +34 -0
  80. package/examples/node/server.mjs +45 -0
  81. package/examples/python/read_cas.py +67 -0
  82. package/examples/vite/index.html +14 -0
  83. package/examples/vite/main.js +22 -0
  84. package/package.json +54 -4
@@ -0,0 +1,779 @@
1
+ /**
2
+ * CasDocument v1 as a runtime schema (zod 4). model.ts stays the source of the
3
+ * TypeScript types; this file mirrors it for validating documents that cross a
4
+ * boundary (worker messages, saved JSON, other tools), and generates the
5
+ * committed JSON Schema (schema/cas-document.v1.schema.json, docs/SCHEMA.md).
6
+ * The guards at the bottom fail the typecheck when the two drift apart.
7
+ *
8
+ * Field descriptions repeat the model.ts / num.ts comments verbatim where they
9
+ * exist, so the JSON Schema documents the same contract.
10
+ */
11
+ import * as z from "zod";
12
+ import type { Issuer, Variant } from "./detect.js";
13
+ import type { CasDocument, Check, CheckStatus, Coverage, Folio, Plan, PlanOption, PrintedTotal, Scheme, Source, Transaction, TxnType } from "./model.js";
14
+ import type { Num } from "./num.js";
15
+ export declare const CAS_DOCUMENT_SCHEMA_ID = "urn:foliolens:schema:cas-document:v1";
16
+ export declare const isoDateSchema: z.ZodISODate;
17
+ export declare const numSchema: z.ZodObject<{
18
+ raw: z.ZodString;
19
+ value: z.ZodString;
20
+ scale: z.ZodInt;
21
+ }, z.core.$strict>;
22
+ export declare const sourceSchema: z.ZodObject<{
23
+ page: z.ZodInt;
24
+ y: z.ZodNumber;
25
+ }, z.core.$strict>;
26
+ export declare const txnTypeSchema: z.ZodEnum<{
27
+ BONUS: "BONUS";
28
+ DIVIDEND_PAYOUT: "DIVIDEND_PAYOUT";
29
+ DIVIDEND_REINVEST: "DIVIDEND_REINVEST";
30
+ GIFT_IN: "GIFT_IN";
31
+ GIFT_OUT: "GIFT_OUT";
32
+ MISC: "MISC";
33
+ PLEDGE: "PLEDGE";
34
+ PLEDGE_INVOKED: "PLEDGE_INVOKED";
35
+ PLEDGE_RELEASE: "PLEDGE_RELEASE";
36
+ PURCHASE: "PURCHASE";
37
+ PURCHASE_SIP: "PURCHASE_SIP";
38
+ REDEMPTION: "REDEMPTION";
39
+ REVERSAL: "REVERSAL";
40
+ SEGREGATION: "SEGREGATION";
41
+ STAMP_DUTY_TAX: "STAMP_DUTY_TAX";
42
+ STT_TAX: "STT_TAX";
43
+ SWITCH_IN: "SWITCH_IN";
44
+ SWITCH_IN_MERGER: "SWITCH_IN_MERGER";
45
+ SWITCH_OUT: "SWITCH_OUT";
46
+ SWITCH_OUT_MERGER: "SWITCH_OUT_MERGER";
47
+ SWP: "SWP";
48
+ TDS_TAX: "TDS_TAX";
49
+ TRANSFER_IN: "TRANSFER_IN";
50
+ TRANSFER_OUT: "TRANSFER_OUT";
51
+ UNIT_ADJUSTMENT: "UNIT_ADJUSTMENT";
52
+ UNKNOWN: "UNKNOWN";
53
+ }>;
54
+ export declare const transactionSchema: z.ZodObject<{
55
+ order: z.ZodInt;
56
+ date: z.ZodISODate;
57
+ description: z.ZodString;
58
+ amount: z.ZodNullable<z.ZodObject<{
59
+ raw: z.ZodString;
60
+ value: z.ZodString;
61
+ scale: z.ZodInt;
62
+ }, z.core.$strict>>;
63
+ units: z.ZodNullable<z.ZodObject<{
64
+ raw: z.ZodString;
65
+ value: z.ZodString;
66
+ scale: z.ZodInt;
67
+ }, z.core.$strict>>;
68
+ price: z.ZodNullable<z.ZodObject<{
69
+ raw: z.ZodString;
70
+ value: z.ZodString;
71
+ scale: z.ZodInt;
72
+ }, z.core.$strict>>;
73
+ balance: z.ZodNullable<z.ZodObject<{
74
+ raw: z.ZodString;
75
+ value: z.ZodString;
76
+ scale: z.ZodInt;
77
+ }, z.core.$strict>>;
78
+ type: z.ZodEnum<{
79
+ BONUS: "BONUS";
80
+ DIVIDEND_PAYOUT: "DIVIDEND_PAYOUT";
81
+ DIVIDEND_REINVEST: "DIVIDEND_REINVEST";
82
+ GIFT_IN: "GIFT_IN";
83
+ GIFT_OUT: "GIFT_OUT";
84
+ MISC: "MISC";
85
+ PLEDGE: "PLEDGE";
86
+ PLEDGE_INVOKED: "PLEDGE_INVOKED";
87
+ PLEDGE_RELEASE: "PLEDGE_RELEASE";
88
+ PURCHASE: "PURCHASE";
89
+ PURCHASE_SIP: "PURCHASE_SIP";
90
+ REDEMPTION: "REDEMPTION";
91
+ REVERSAL: "REVERSAL";
92
+ SEGREGATION: "SEGREGATION";
93
+ STAMP_DUTY_TAX: "STAMP_DUTY_TAX";
94
+ STT_TAX: "STT_TAX";
95
+ SWITCH_IN: "SWITCH_IN";
96
+ SWITCH_IN_MERGER: "SWITCH_IN_MERGER";
97
+ SWITCH_OUT: "SWITCH_OUT";
98
+ SWITCH_OUT_MERGER: "SWITCH_OUT_MERGER";
99
+ SWP: "SWP";
100
+ TDS_TAX: "TDS_TAX";
101
+ TRANSFER_IN: "TRANSFER_IN";
102
+ TRANSFER_OUT: "TRANSFER_OUT";
103
+ UNIT_ADJUSTMENT: "UNIT_ADJUSTMENT";
104
+ UNKNOWN: "UNKNOWN";
105
+ }>;
106
+ dividendRate: z.ZodNullable<z.ZodString>;
107
+ giftFolio: z.ZodNullable<z.ZodString>;
108
+ signCorrected: z.ZodBoolean;
109
+ source: z.ZodObject<{
110
+ page: z.ZodInt;
111
+ y: z.ZodNumber;
112
+ }, z.core.$strict>;
113
+ }, z.core.$strict>;
114
+ export declare const checkStatusSchema: z.ZodEnum<{
115
+ fail: "fail";
116
+ not_applicable: "not_applicable";
117
+ pass: "pass";
118
+ unavailable: "unavailable";
119
+ }>;
120
+ export declare const checkSchema: z.ZodObject<{
121
+ id: z.ZodString;
122
+ status: z.ZodEnum<{
123
+ fail: "fail";
124
+ not_applicable: "not_applicable";
125
+ pass: "pass";
126
+ unavailable: "unavailable";
127
+ }>;
128
+ expected: z.ZodExactOptional<z.ZodString>;
129
+ observed: z.ZodExactOptional<z.ZodString>;
130
+ tolerance: z.ZodExactOptional<z.ZodString>;
131
+ detail: z.ZodExactOptional<z.ZodString>;
132
+ source: z.ZodExactOptional<z.ZodObject<{
133
+ page: z.ZodInt;
134
+ y: z.ZodNumber;
135
+ }, z.core.$strict>>;
136
+ }, z.core.$strict>;
137
+ export declare const planSchema: z.ZodEnum<{
138
+ DIRECT: "DIRECT";
139
+ REGULAR: "REGULAR";
140
+ UNKNOWN: "UNKNOWN";
141
+ }>;
142
+ export declare const planOptionSchema: z.ZodEnum<{
143
+ GROWTH: "GROWTH";
144
+ IDCW_PAYOUT: "IDCW_PAYOUT";
145
+ IDCW_REINVEST: "IDCW_REINVEST";
146
+ UNKNOWN: "UNKNOWN";
147
+ }>;
148
+ export declare const schemeSchema: z.ZodObject<{
149
+ name: z.ZodString;
150
+ rtaCode: z.ZodString;
151
+ rta: z.ZodString;
152
+ isin: z.ZodNullable<z.ZodString>;
153
+ advisor: z.ZodNullable<z.ZodString>;
154
+ plan: z.ZodEnum<{
155
+ DIRECT: "DIRECT";
156
+ REGULAR: "REGULAR";
157
+ UNKNOWN: "UNKNOWN";
158
+ }>;
159
+ option: z.ZodEnum<{
160
+ GROWTH: "GROWTH";
161
+ IDCW_PAYOUT: "IDCW_PAYOUT";
162
+ IDCW_REINVEST: "IDCW_REINVEST";
163
+ UNKNOWN: "UNKNOWN";
164
+ }>;
165
+ nominees: z.ZodArray<z.ZodString>;
166
+ open: z.ZodNullable<z.ZodObject<{
167
+ raw: z.ZodString;
168
+ value: z.ZodString;
169
+ scale: z.ZodInt;
170
+ }, z.core.$strict>>;
171
+ close: z.ZodNullable<z.ZodObject<{
172
+ raw: z.ZodString;
173
+ value: z.ZodString;
174
+ scale: z.ZodInt;
175
+ }, z.core.$strict>>;
176
+ closeCalculated: z.ZodNullable<z.ZodString>;
177
+ nav: z.ZodNullable<z.ZodObject<{
178
+ date: z.ZodISODate;
179
+ value: z.ZodObject<{
180
+ raw: z.ZodString;
181
+ value: z.ZodString;
182
+ scale: z.ZodInt;
183
+ }, z.core.$strict>;
184
+ }, z.core.$strict>>;
185
+ valuation: z.ZodNullable<z.ZodObject<{
186
+ date: z.ZodISODate;
187
+ value: z.ZodObject<{
188
+ raw: z.ZodString;
189
+ value: z.ZodString;
190
+ scale: z.ZodInt;
191
+ }, z.core.$strict>;
192
+ }, z.core.$strict>>;
193
+ cost: z.ZodNullable<z.ZodObject<{
194
+ raw: z.ZodString;
195
+ value: z.ZodString;
196
+ scale: z.ZodInt;
197
+ }, z.core.$strict>>;
198
+ transactions: z.ZodArray<z.ZodObject<{
199
+ order: z.ZodInt;
200
+ date: z.ZodISODate;
201
+ description: z.ZodString;
202
+ amount: z.ZodNullable<z.ZodObject<{
203
+ raw: z.ZodString;
204
+ value: z.ZodString;
205
+ scale: z.ZodInt;
206
+ }, z.core.$strict>>;
207
+ units: z.ZodNullable<z.ZodObject<{
208
+ raw: z.ZodString;
209
+ value: z.ZodString;
210
+ scale: z.ZodInt;
211
+ }, z.core.$strict>>;
212
+ price: z.ZodNullable<z.ZodObject<{
213
+ raw: z.ZodString;
214
+ value: z.ZodString;
215
+ scale: z.ZodInt;
216
+ }, z.core.$strict>>;
217
+ balance: z.ZodNullable<z.ZodObject<{
218
+ raw: z.ZodString;
219
+ value: z.ZodString;
220
+ scale: z.ZodInt;
221
+ }, z.core.$strict>>;
222
+ type: z.ZodEnum<{
223
+ BONUS: "BONUS";
224
+ DIVIDEND_PAYOUT: "DIVIDEND_PAYOUT";
225
+ DIVIDEND_REINVEST: "DIVIDEND_REINVEST";
226
+ GIFT_IN: "GIFT_IN";
227
+ GIFT_OUT: "GIFT_OUT";
228
+ MISC: "MISC";
229
+ PLEDGE: "PLEDGE";
230
+ PLEDGE_INVOKED: "PLEDGE_INVOKED";
231
+ PLEDGE_RELEASE: "PLEDGE_RELEASE";
232
+ PURCHASE: "PURCHASE";
233
+ PURCHASE_SIP: "PURCHASE_SIP";
234
+ REDEMPTION: "REDEMPTION";
235
+ REVERSAL: "REVERSAL";
236
+ SEGREGATION: "SEGREGATION";
237
+ STAMP_DUTY_TAX: "STAMP_DUTY_TAX";
238
+ STT_TAX: "STT_TAX";
239
+ SWITCH_IN: "SWITCH_IN";
240
+ SWITCH_IN_MERGER: "SWITCH_IN_MERGER";
241
+ SWITCH_OUT: "SWITCH_OUT";
242
+ SWITCH_OUT_MERGER: "SWITCH_OUT_MERGER";
243
+ SWP: "SWP";
244
+ TDS_TAX: "TDS_TAX";
245
+ TRANSFER_IN: "TRANSFER_IN";
246
+ TRANSFER_OUT: "TRANSFER_OUT";
247
+ UNIT_ADJUSTMENT: "UNIT_ADJUSTMENT";
248
+ UNKNOWN: "UNKNOWN";
249
+ }>;
250
+ dividendRate: z.ZodNullable<z.ZodString>;
251
+ giftFolio: z.ZodNullable<z.ZodString>;
252
+ signCorrected: z.ZodBoolean;
253
+ source: z.ZodObject<{
254
+ page: z.ZodInt;
255
+ y: z.ZodNumber;
256
+ }, z.core.$strict>;
257
+ }, z.core.$strict>>;
258
+ checks: z.ZodArray<z.ZodObject<{
259
+ id: z.ZodString;
260
+ status: z.ZodEnum<{
261
+ fail: "fail";
262
+ not_applicable: "not_applicable";
263
+ pass: "pass";
264
+ unavailable: "unavailable";
265
+ }>;
266
+ expected: z.ZodExactOptional<z.ZodString>;
267
+ observed: z.ZodExactOptional<z.ZodString>;
268
+ tolerance: z.ZodExactOptional<z.ZodString>;
269
+ detail: z.ZodExactOptional<z.ZodString>;
270
+ source: z.ZodExactOptional<z.ZodObject<{
271
+ page: z.ZodInt;
272
+ y: z.ZodNumber;
273
+ }, z.core.$strict>>;
274
+ }, z.core.$strict>>;
275
+ source: z.ZodObject<{
276
+ page: z.ZodInt;
277
+ y: z.ZodNumber;
278
+ }, z.core.$strict>;
279
+ footerSource: z.ZodNullable<z.ZodObject<{
280
+ page: z.ZodInt;
281
+ y: z.ZodNumber;
282
+ }, z.core.$strict>>;
283
+ }, z.core.$strict>;
284
+ export declare const folioSchema: z.ZodObject<{
285
+ folio: z.ZodString;
286
+ amc: z.ZodString;
287
+ pan: z.ZodNullable<z.ZodString>;
288
+ kyc: z.ZodNullable<z.ZodString>;
289
+ panKyc: z.ZodNullable<z.ZodString>;
290
+ holderName: z.ZodNullable<z.ZodString>;
291
+ schemes: z.ZodArray<z.ZodObject<{
292
+ name: z.ZodString;
293
+ rtaCode: z.ZodString;
294
+ rta: z.ZodString;
295
+ isin: z.ZodNullable<z.ZodString>;
296
+ advisor: z.ZodNullable<z.ZodString>;
297
+ plan: z.ZodEnum<{
298
+ DIRECT: "DIRECT";
299
+ REGULAR: "REGULAR";
300
+ UNKNOWN: "UNKNOWN";
301
+ }>;
302
+ option: z.ZodEnum<{
303
+ GROWTH: "GROWTH";
304
+ IDCW_PAYOUT: "IDCW_PAYOUT";
305
+ IDCW_REINVEST: "IDCW_REINVEST";
306
+ UNKNOWN: "UNKNOWN";
307
+ }>;
308
+ nominees: z.ZodArray<z.ZodString>;
309
+ open: z.ZodNullable<z.ZodObject<{
310
+ raw: z.ZodString;
311
+ value: z.ZodString;
312
+ scale: z.ZodInt;
313
+ }, z.core.$strict>>;
314
+ close: z.ZodNullable<z.ZodObject<{
315
+ raw: z.ZodString;
316
+ value: z.ZodString;
317
+ scale: z.ZodInt;
318
+ }, z.core.$strict>>;
319
+ closeCalculated: z.ZodNullable<z.ZodString>;
320
+ nav: z.ZodNullable<z.ZodObject<{
321
+ date: z.ZodISODate;
322
+ value: z.ZodObject<{
323
+ raw: z.ZodString;
324
+ value: z.ZodString;
325
+ scale: z.ZodInt;
326
+ }, z.core.$strict>;
327
+ }, z.core.$strict>>;
328
+ valuation: z.ZodNullable<z.ZodObject<{
329
+ date: z.ZodISODate;
330
+ value: z.ZodObject<{
331
+ raw: z.ZodString;
332
+ value: z.ZodString;
333
+ scale: z.ZodInt;
334
+ }, z.core.$strict>;
335
+ }, z.core.$strict>>;
336
+ cost: z.ZodNullable<z.ZodObject<{
337
+ raw: z.ZodString;
338
+ value: z.ZodString;
339
+ scale: z.ZodInt;
340
+ }, z.core.$strict>>;
341
+ transactions: z.ZodArray<z.ZodObject<{
342
+ order: z.ZodInt;
343
+ date: z.ZodISODate;
344
+ description: z.ZodString;
345
+ amount: z.ZodNullable<z.ZodObject<{
346
+ raw: z.ZodString;
347
+ value: z.ZodString;
348
+ scale: z.ZodInt;
349
+ }, z.core.$strict>>;
350
+ units: z.ZodNullable<z.ZodObject<{
351
+ raw: z.ZodString;
352
+ value: z.ZodString;
353
+ scale: z.ZodInt;
354
+ }, z.core.$strict>>;
355
+ price: z.ZodNullable<z.ZodObject<{
356
+ raw: z.ZodString;
357
+ value: z.ZodString;
358
+ scale: z.ZodInt;
359
+ }, z.core.$strict>>;
360
+ balance: z.ZodNullable<z.ZodObject<{
361
+ raw: z.ZodString;
362
+ value: z.ZodString;
363
+ scale: z.ZodInt;
364
+ }, z.core.$strict>>;
365
+ type: z.ZodEnum<{
366
+ BONUS: "BONUS";
367
+ DIVIDEND_PAYOUT: "DIVIDEND_PAYOUT";
368
+ DIVIDEND_REINVEST: "DIVIDEND_REINVEST";
369
+ GIFT_IN: "GIFT_IN";
370
+ GIFT_OUT: "GIFT_OUT";
371
+ MISC: "MISC";
372
+ PLEDGE: "PLEDGE";
373
+ PLEDGE_INVOKED: "PLEDGE_INVOKED";
374
+ PLEDGE_RELEASE: "PLEDGE_RELEASE";
375
+ PURCHASE: "PURCHASE";
376
+ PURCHASE_SIP: "PURCHASE_SIP";
377
+ REDEMPTION: "REDEMPTION";
378
+ REVERSAL: "REVERSAL";
379
+ SEGREGATION: "SEGREGATION";
380
+ STAMP_DUTY_TAX: "STAMP_DUTY_TAX";
381
+ STT_TAX: "STT_TAX";
382
+ SWITCH_IN: "SWITCH_IN";
383
+ SWITCH_IN_MERGER: "SWITCH_IN_MERGER";
384
+ SWITCH_OUT: "SWITCH_OUT";
385
+ SWITCH_OUT_MERGER: "SWITCH_OUT_MERGER";
386
+ SWP: "SWP";
387
+ TDS_TAX: "TDS_TAX";
388
+ TRANSFER_IN: "TRANSFER_IN";
389
+ TRANSFER_OUT: "TRANSFER_OUT";
390
+ UNIT_ADJUSTMENT: "UNIT_ADJUSTMENT";
391
+ UNKNOWN: "UNKNOWN";
392
+ }>;
393
+ dividendRate: z.ZodNullable<z.ZodString>;
394
+ giftFolio: z.ZodNullable<z.ZodString>;
395
+ signCorrected: z.ZodBoolean;
396
+ source: z.ZodObject<{
397
+ page: z.ZodInt;
398
+ y: z.ZodNumber;
399
+ }, z.core.$strict>;
400
+ }, z.core.$strict>>;
401
+ checks: z.ZodArray<z.ZodObject<{
402
+ id: z.ZodString;
403
+ status: z.ZodEnum<{
404
+ fail: "fail";
405
+ not_applicable: "not_applicable";
406
+ pass: "pass";
407
+ unavailable: "unavailable";
408
+ }>;
409
+ expected: z.ZodExactOptional<z.ZodString>;
410
+ observed: z.ZodExactOptional<z.ZodString>;
411
+ tolerance: z.ZodExactOptional<z.ZodString>;
412
+ detail: z.ZodExactOptional<z.ZodString>;
413
+ source: z.ZodExactOptional<z.ZodObject<{
414
+ page: z.ZodInt;
415
+ y: z.ZodNumber;
416
+ }, z.core.$strict>>;
417
+ }, z.core.$strict>>;
418
+ source: z.ZodObject<{
419
+ page: z.ZodInt;
420
+ y: z.ZodNumber;
421
+ }, z.core.$strict>;
422
+ footerSource: z.ZodNullable<z.ZodObject<{
423
+ page: z.ZodInt;
424
+ y: z.ZodNumber;
425
+ }, z.core.$strict>>;
426
+ }, z.core.$strict>>;
427
+ }, z.core.$strict>;
428
+ export declare const printedTotalSchema: z.ZodObject<{
429
+ label: z.ZodString;
430
+ cost: z.ZodNullable<z.ZodObject<{
431
+ raw: z.ZodString;
432
+ value: z.ZodString;
433
+ scale: z.ZodInt;
434
+ }, z.core.$strict>>;
435
+ marketValue: z.ZodNullable<z.ZodObject<{
436
+ raw: z.ZodString;
437
+ value: z.ZodString;
438
+ scale: z.ZodInt;
439
+ }, z.core.$strict>>;
440
+ source: z.ZodObject<{
441
+ page: z.ZodInt;
442
+ y: z.ZodNumber;
443
+ }, z.core.$strict>;
444
+ }, z.core.$strict>;
445
+ export declare const coverageSchema: z.ZodObject<{
446
+ pages: z.ZodInt;
447
+ datedRowsSeen: z.ZodInt;
448
+ transactionsParsed: z.ZodInt;
449
+ datedRowsSkipped: z.ZodArray<z.ZodObject<{
450
+ source: z.ZodObject<{
451
+ page: z.ZodInt;
452
+ y: z.ZodNumber;
453
+ }, z.core.$strict>;
454
+ reason: z.ZodString;
455
+ }, z.core.$strict>>;
456
+ ambiguousCells: z.ZodArray<z.ZodObject<{
457
+ source: z.ZodObject<{
458
+ page: z.ZodInt;
459
+ y: z.ZodNumber;
460
+ }, z.core.$strict>;
461
+ text: z.ZodString;
462
+ reason: z.ZodString;
463
+ }, z.core.$strict>>;
464
+ schemeRegionsUnbuilt: z.ZodArray<z.ZodObject<{
465
+ source: z.ZodObject<{
466
+ page: z.ZodInt;
467
+ y: z.ZodNumber;
468
+ }, z.core.$strict>;
469
+ reason: z.ZodString;
470
+ }, z.core.$strict>>;
471
+ }, z.core.$strict>;
472
+ export declare const provenanceSchema: z.ZodObject<{
473
+ sha256: z.ZodString;
474
+ pageCount: z.ZodInt;
475
+ producer: z.ZodNullable<z.ZodString>;
476
+ creator: z.ZodNullable<z.ZodString>;
477
+ pdfVersion: z.ZodNullable<z.ZodString>;
478
+ encrypted: z.ZodBoolean;
479
+ extractor: z.ZodString;
480
+ }, z.core.$strict>;
481
+ export declare const issuerSchema: z.ZodEnum<{
482
+ CAMS: "CAMS";
483
+ CDSL: "CDSL";
484
+ KFINTECH: "KFINTECH";
485
+ NSDL: "NSDL";
486
+ }>;
487
+ export declare const variantSchema: z.ZodEnum<{
488
+ DEMAT: "DEMAT";
489
+ DETAILED: "DETAILED";
490
+ SUMMARY: "SUMMARY";
491
+ }>;
492
+ export declare const casDocumentSchema: z.ZodObject<{
493
+ schemaVersion: z.ZodLiteral<"1">;
494
+ source: z.ZodObject<{
495
+ issuer: z.ZodEnum<{
496
+ CAMS: "CAMS";
497
+ CDSL: "CDSL";
498
+ KFINTECH: "KFINTECH";
499
+ NSDL: "NSDL";
500
+ }>;
501
+ variant: z.ZodEnum<{
502
+ DEMAT: "DEMAT";
503
+ DETAILED: "DETAILED";
504
+ SUMMARY: "SUMMARY";
505
+ }>;
506
+ engineVersion: z.ZodString;
507
+ }, z.core.$strict>;
508
+ provenance: z.ZodObject<{
509
+ sha256: z.ZodString;
510
+ pageCount: z.ZodInt;
511
+ producer: z.ZodNullable<z.ZodString>;
512
+ creator: z.ZodNullable<z.ZodString>;
513
+ pdfVersion: z.ZodNullable<z.ZodString>;
514
+ encrypted: z.ZodBoolean;
515
+ extractor: z.ZodString;
516
+ }, z.core.$strict>;
517
+ statementPeriod: z.ZodNullable<z.ZodObject<{
518
+ from: z.ZodISODate;
519
+ to: z.ZodISODate;
520
+ }, z.core.$strict>>;
521
+ addressee: z.ZodObject<{
522
+ name: z.ZodNullable<z.ZodString>;
523
+ email: z.ZodNullable<z.ZodString>;
524
+ mobile: z.ZodNullable<z.ZodString>;
525
+ address: z.ZodNullable<z.ZodString>;
526
+ }, z.core.$strict>;
527
+ folios: z.ZodArray<z.ZodObject<{
528
+ folio: z.ZodString;
529
+ amc: z.ZodString;
530
+ pan: z.ZodNullable<z.ZodString>;
531
+ kyc: z.ZodNullable<z.ZodString>;
532
+ panKyc: z.ZodNullable<z.ZodString>;
533
+ holderName: z.ZodNullable<z.ZodString>;
534
+ schemes: z.ZodArray<z.ZodObject<{
535
+ name: z.ZodString;
536
+ rtaCode: z.ZodString;
537
+ rta: z.ZodString;
538
+ isin: z.ZodNullable<z.ZodString>;
539
+ advisor: z.ZodNullable<z.ZodString>;
540
+ plan: z.ZodEnum<{
541
+ DIRECT: "DIRECT";
542
+ REGULAR: "REGULAR";
543
+ UNKNOWN: "UNKNOWN";
544
+ }>;
545
+ option: z.ZodEnum<{
546
+ GROWTH: "GROWTH";
547
+ IDCW_PAYOUT: "IDCW_PAYOUT";
548
+ IDCW_REINVEST: "IDCW_REINVEST";
549
+ UNKNOWN: "UNKNOWN";
550
+ }>;
551
+ nominees: z.ZodArray<z.ZodString>;
552
+ open: z.ZodNullable<z.ZodObject<{
553
+ raw: z.ZodString;
554
+ value: z.ZodString;
555
+ scale: z.ZodInt;
556
+ }, z.core.$strict>>;
557
+ close: z.ZodNullable<z.ZodObject<{
558
+ raw: z.ZodString;
559
+ value: z.ZodString;
560
+ scale: z.ZodInt;
561
+ }, z.core.$strict>>;
562
+ closeCalculated: z.ZodNullable<z.ZodString>;
563
+ nav: z.ZodNullable<z.ZodObject<{
564
+ date: z.ZodISODate;
565
+ value: z.ZodObject<{
566
+ raw: z.ZodString;
567
+ value: z.ZodString;
568
+ scale: z.ZodInt;
569
+ }, z.core.$strict>;
570
+ }, z.core.$strict>>;
571
+ valuation: z.ZodNullable<z.ZodObject<{
572
+ date: z.ZodISODate;
573
+ value: z.ZodObject<{
574
+ raw: z.ZodString;
575
+ value: z.ZodString;
576
+ scale: z.ZodInt;
577
+ }, z.core.$strict>;
578
+ }, z.core.$strict>>;
579
+ cost: z.ZodNullable<z.ZodObject<{
580
+ raw: z.ZodString;
581
+ value: z.ZodString;
582
+ scale: z.ZodInt;
583
+ }, z.core.$strict>>;
584
+ transactions: z.ZodArray<z.ZodObject<{
585
+ order: z.ZodInt;
586
+ date: z.ZodISODate;
587
+ description: z.ZodString;
588
+ amount: z.ZodNullable<z.ZodObject<{
589
+ raw: z.ZodString;
590
+ value: z.ZodString;
591
+ scale: z.ZodInt;
592
+ }, z.core.$strict>>;
593
+ units: z.ZodNullable<z.ZodObject<{
594
+ raw: z.ZodString;
595
+ value: z.ZodString;
596
+ scale: z.ZodInt;
597
+ }, z.core.$strict>>;
598
+ price: z.ZodNullable<z.ZodObject<{
599
+ raw: z.ZodString;
600
+ value: z.ZodString;
601
+ scale: z.ZodInt;
602
+ }, z.core.$strict>>;
603
+ balance: z.ZodNullable<z.ZodObject<{
604
+ raw: z.ZodString;
605
+ value: z.ZodString;
606
+ scale: z.ZodInt;
607
+ }, z.core.$strict>>;
608
+ type: z.ZodEnum<{
609
+ BONUS: "BONUS";
610
+ DIVIDEND_PAYOUT: "DIVIDEND_PAYOUT";
611
+ DIVIDEND_REINVEST: "DIVIDEND_REINVEST";
612
+ GIFT_IN: "GIFT_IN";
613
+ GIFT_OUT: "GIFT_OUT";
614
+ MISC: "MISC";
615
+ PLEDGE: "PLEDGE";
616
+ PLEDGE_INVOKED: "PLEDGE_INVOKED";
617
+ PLEDGE_RELEASE: "PLEDGE_RELEASE";
618
+ PURCHASE: "PURCHASE";
619
+ PURCHASE_SIP: "PURCHASE_SIP";
620
+ REDEMPTION: "REDEMPTION";
621
+ REVERSAL: "REVERSAL";
622
+ SEGREGATION: "SEGREGATION";
623
+ STAMP_DUTY_TAX: "STAMP_DUTY_TAX";
624
+ STT_TAX: "STT_TAX";
625
+ SWITCH_IN: "SWITCH_IN";
626
+ SWITCH_IN_MERGER: "SWITCH_IN_MERGER";
627
+ SWITCH_OUT: "SWITCH_OUT";
628
+ SWITCH_OUT_MERGER: "SWITCH_OUT_MERGER";
629
+ SWP: "SWP";
630
+ TDS_TAX: "TDS_TAX";
631
+ TRANSFER_IN: "TRANSFER_IN";
632
+ TRANSFER_OUT: "TRANSFER_OUT";
633
+ UNIT_ADJUSTMENT: "UNIT_ADJUSTMENT";
634
+ UNKNOWN: "UNKNOWN";
635
+ }>;
636
+ dividendRate: z.ZodNullable<z.ZodString>;
637
+ giftFolio: z.ZodNullable<z.ZodString>;
638
+ signCorrected: z.ZodBoolean;
639
+ source: z.ZodObject<{
640
+ page: z.ZodInt;
641
+ y: z.ZodNumber;
642
+ }, z.core.$strict>;
643
+ }, z.core.$strict>>;
644
+ checks: z.ZodArray<z.ZodObject<{
645
+ id: z.ZodString;
646
+ status: z.ZodEnum<{
647
+ fail: "fail";
648
+ not_applicable: "not_applicable";
649
+ pass: "pass";
650
+ unavailable: "unavailable";
651
+ }>;
652
+ expected: z.ZodExactOptional<z.ZodString>;
653
+ observed: z.ZodExactOptional<z.ZodString>;
654
+ tolerance: z.ZodExactOptional<z.ZodString>;
655
+ detail: z.ZodExactOptional<z.ZodString>;
656
+ source: z.ZodExactOptional<z.ZodObject<{
657
+ page: z.ZodInt;
658
+ y: z.ZodNumber;
659
+ }, z.core.$strict>>;
660
+ }, z.core.$strict>>;
661
+ source: z.ZodObject<{
662
+ page: z.ZodInt;
663
+ y: z.ZodNumber;
664
+ }, z.core.$strict>;
665
+ footerSource: z.ZodNullable<z.ZodObject<{
666
+ page: z.ZodInt;
667
+ y: z.ZodNumber;
668
+ }, z.core.$strict>>;
669
+ }, z.core.$strict>>;
670
+ }, z.core.$strict>>;
671
+ printedTotal: z.ZodNullable<z.ZodObject<{
672
+ label: z.ZodString;
673
+ cost: z.ZodNullable<z.ZodObject<{
674
+ raw: z.ZodString;
675
+ value: z.ZodString;
676
+ scale: z.ZodInt;
677
+ }, z.core.$strict>>;
678
+ marketValue: z.ZodNullable<z.ZodObject<{
679
+ raw: z.ZodString;
680
+ value: z.ZodString;
681
+ scale: z.ZodInt;
682
+ }, z.core.$strict>>;
683
+ source: z.ZodObject<{
684
+ page: z.ZodInt;
685
+ y: z.ZodNumber;
686
+ }, z.core.$strict>;
687
+ }, z.core.$strict>>;
688
+ checks: z.ZodArray<z.ZodObject<{
689
+ id: z.ZodString;
690
+ status: z.ZodEnum<{
691
+ fail: "fail";
692
+ not_applicable: "not_applicable";
693
+ pass: "pass";
694
+ unavailable: "unavailable";
695
+ }>;
696
+ expected: z.ZodExactOptional<z.ZodString>;
697
+ observed: z.ZodExactOptional<z.ZodString>;
698
+ tolerance: z.ZodExactOptional<z.ZodString>;
699
+ detail: z.ZodExactOptional<z.ZodString>;
700
+ source: z.ZodExactOptional<z.ZodObject<{
701
+ page: z.ZodInt;
702
+ y: z.ZodNumber;
703
+ }, z.core.$strict>>;
704
+ }, z.core.$strict>>;
705
+ coverage: z.ZodObject<{
706
+ pages: z.ZodInt;
707
+ datedRowsSeen: z.ZodInt;
708
+ transactionsParsed: z.ZodInt;
709
+ datedRowsSkipped: z.ZodArray<z.ZodObject<{
710
+ source: z.ZodObject<{
711
+ page: z.ZodInt;
712
+ y: z.ZodNumber;
713
+ }, z.core.$strict>;
714
+ reason: z.ZodString;
715
+ }, z.core.$strict>>;
716
+ ambiguousCells: z.ZodArray<z.ZodObject<{
717
+ source: z.ZodObject<{
718
+ page: z.ZodInt;
719
+ y: z.ZodNumber;
720
+ }, z.core.$strict>;
721
+ text: z.ZodString;
722
+ reason: z.ZodString;
723
+ }, z.core.$strict>>;
724
+ schemeRegionsUnbuilt: z.ZodArray<z.ZodObject<{
725
+ source: z.ZodObject<{
726
+ page: z.ZodInt;
727
+ y: z.ZodNumber;
728
+ }, z.core.$strict>;
729
+ reason: z.ZodString;
730
+ }, z.core.$strict>>;
731
+ }, z.core.$strict>;
732
+ warnings: z.ZodArray<z.ZodString>;
733
+ }, z.core.$strict>;
734
+ /** One schema violation. Carries where and why, never the offending value, so it is safe to log. */
735
+ export interface SchemaIssue {
736
+ /** JSON Pointer (RFC 6901) to the offending location, e.g. "/folios/0/schemes/1/isin". "" is the document itself. */
737
+ path: string;
738
+ /** Zod issue code, e.g. "invalid_type", "invalid_value", "unrecognized_keys". */
739
+ code: string;
740
+ message: string;
741
+ }
742
+ export type CasDocumentValidation = {
743
+ ok: true;
744
+ document: CasDocument;
745
+ } | {
746
+ ok: false;
747
+ issues: SchemaIssue[];
748
+ };
749
+ /**
750
+ * Checks an untrusted value against CasDocument v1. Unknown properties are
751
+ * rejected. On success `document` is a validated copy of the input.
752
+ */
753
+ export declare function validateCasDocument(x: unknown): CasDocumentValidation;
754
+ /** The JSON Schema (draft 2020-12) committed as schema/cas-document.v1.schema.json. */
755
+ export declare function casDocumentJsonSchema(): Record<string, unknown>;
756
+ type Same<A, B> = [A] extends [B] ? ([B] extends [A] ? true : false) : false;
757
+ type Mirrors<A, B> = Same<A, B> extends true ? Same<keyof A, keyof B> : false;
758
+ type Assert<T extends true> = T;
759
+ export type SchemaDriftGuard = [
760
+ Assert<Mirrors<z.infer<typeof numSchema>, Num>>,
761
+ Assert<Mirrors<z.infer<typeof sourceSchema>, Source>>,
762
+ Assert<Same<z.infer<typeof txnTypeSchema>, TxnType>>,
763
+ Assert<Mirrors<z.infer<typeof transactionSchema>, Transaction>>,
764
+ Assert<Same<z.infer<typeof checkStatusSchema>, CheckStatus>>,
765
+ Assert<Mirrors<z.infer<typeof checkSchema>, Check>>,
766
+ Assert<Same<z.infer<typeof planSchema>, Plan>>,
767
+ Assert<Same<z.infer<typeof planOptionSchema>, PlanOption>>,
768
+ Assert<Mirrors<z.infer<typeof schemeSchema>, Scheme>>,
769
+ Assert<Mirrors<z.infer<typeof folioSchema>, Folio>>,
770
+ Assert<Mirrors<z.infer<typeof coverageSchema>, Coverage>>,
771
+ Assert<Mirrors<z.infer<typeof printedTotalSchema>, PrintedTotal>>,
772
+ Assert<Mirrors<z.infer<typeof provenanceSchema>, CasDocument["provenance"]>>,
773
+ Assert<Same<z.infer<typeof issuerSchema>, Issuer>>,
774
+ Assert<Same<z.infer<typeof variantSchema>, Variant>>,
775
+ Assert<Mirrors<z.infer<typeof casDocumentSchema>["source"], CasDocument["source"]>>,
776
+ Assert<Mirrors<z.infer<typeof casDocumentSchema>["addressee"], CasDocument["addressee"]>>,
777
+ Assert<Mirrors<z.infer<typeof casDocumentSchema>, CasDocument>>
778
+ ];
779
+ export {};