@rundit-sdk/embed 0.3.1 → 0.3.3

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.
package/dist/index.d.ts CHANGED
@@ -107,6 +107,7 @@ export interface SdkCompanyPositionDto {
107
107
  exitProfits?: number | null
108
108
  equityFairValue?: number | null
109
109
  multiple?: number | null
110
+ realizedMultiple?: number | null
110
111
  roundInfo?: SdkFundingRoundInfoDto
111
112
  valuationMethod?: "Historical" | "NewFinancingRound" | "PubliclyListedSecurity" | "Realization" | "RecentTransactionMultiples" | "RecentMarketMultiples" | "RecentMarketAndTransactionMultiples" | "DiscountToPrimaryRound" | "ThirdPartyOpinion" | "Dcf" | "Other"
112
113
  totalFundingRaised?: number | null
@@ -359,7 +360,7 @@ export interface SdkCompanyReportSummaryDto {
359
360
  title: string
360
361
  date: string
361
362
  timeframe: { }
362
- publishedAt?: string | null
363
+ publishedAt: string | null
363
364
  company: SdkCompanyReferenceDto
364
365
  }
365
366
 
@@ -533,6 +534,7 @@ export interface SdkPortfolioPositionDto {
533
534
  fairValue?: number | null
534
535
  invested?: number | null
535
536
  multiple?: number | null
537
+ realizedMultiple?: number | null
536
538
  ownership?: number | null
537
539
  realized?: number | null
538
540
  xirr?: number | null
@@ -698,20 +700,71 @@ export interface SdkUserReferenceDto {
698
700
  name: string
699
701
  }
700
702
 
703
+ export type SdkReportSectionType = "text"
704
+
705
+ export interface SdkTextReportSectionDto {
706
+ id: number
707
+ type: SdkReportSectionType
708
+ order: number
709
+ title: string
710
+ content: string | null
711
+ }
712
+
713
+ export interface SdkMarkdownReportSectionDto {
714
+ id: number
715
+ type: SdkReportSectionType
716
+ order: number
717
+ title: string
718
+ content: string | null
719
+ }
720
+
701
721
  export interface SdkCompanyReportAttachmentDto {
702
722
  id: number
703
723
  name: string
704
- url?: string | null
724
+ url: string | null
725
+ }
726
+
727
+ export interface SdkImageReportSectionDto {
728
+ id: number
729
+ type: SdkReportSectionType
730
+ order: number
731
+ title: string
732
+ imageUrl: string | null
733
+ file: SdkCompanyReportAttachmentDto
734
+ }
735
+
736
+ export interface SdkChartReportSectionDto {
737
+ id: number
738
+ type: SdkReportSectionType
739
+ order: number
740
+ title: string
741
+ content: { }
742
+ }
743
+
744
+ export interface SdkTableReportSectionDto {
745
+ id: number
746
+ type: SdkReportSectionType
747
+ order: number
748
+ title: string
749
+ content: { }
750
+ }
751
+
752
+ export interface SdkSingleChoiceReportSectionDto {
753
+ id: number
754
+ type: SdkReportSectionType
755
+ order: number
756
+ title: string
757
+ options: string[]
758
+ selectedOptions: string[]
705
759
  }
706
760
 
707
- export interface SdkCompanyReportSectionDto {
761
+ export interface SdkMultiChoiceReportSectionDto {
708
762
  id: number
709
- type: { }
763
+ type: SdkReportSectionType
710
764
  order: number
711
765
  title: string
712
- content?: string | null
713
- file?: SdkCompanyReportAttachmentDto
714
- imageUrl?: string | null
766
+ options: string[]
767
+ selectedOptions: string[]
715
768
  }
716
769
 
717
770
  export interface SdkCompanyReportDto {
@@ -719,10 +772,10 @@ export interface SdkCompanyReportDto {
719
772
  title: string
720
773
  date: string
721
774
  timeframe: { }
722
- publishedAt?: string | null
775
+ publishedAt: string | null
723
776
  company: SdkCompanyReferenceDto
724
- createdBy?: SdkUserReferenceDto
725
- sections: SdkCompanyReportSectionDto[]
777
+ createdBy: SdkUserReferenceDto
778
+ sections: (SdkTextReportSectionDto | SdkMarkdownReportSectionDto | SdkImageReportSectionDto | SdkChartReportSectionDto | SdkTableReportSectionDto | SdkSingleChoiceReportSectionDto | SdkMultiChoiceReportSectionDto)[]
726
779
  attachments: SdkCompanyReportAttachmentDto[]
727
780
  }
728
781
 
package/openapi.json CHANGED
@@ -1977,6 +1977,11 @@
1977
1977
  "description": "Investment multiple",
1978
1978
  "nullable": true
1979
1979
  },
1980
+ "realizedMultiple": {
1981
+ "type": "number",
1982
+ "description": "Realized MOIC (realized over invested); null until some cash has been realized",
1983
+ "nullable": true
1984
+ },
1980
1985
  "roundInfo": {
1981
1986
  "description": "Funding round info",
1982
1987
  "nullable": true,
@@ -2392,6 +2397,7 @@
2392
2397
  "title",
2393
2398
  "date",
2394
2399
  "timeframe",
2400
+ "publishedAt",
2395
2401
  "company"
2396
2402
  ]
2397
2403
  },
@@ -3120,6 +3126,11 @@
3120
3126
  "description": "Aggregate investment multiple",
3121
3127
  "nullable": true
3122
3128
  },
3129
+ "realizedMultiple": {
3130
+ "type": "number",
3131
+ "description": "Aggregate realized MOIC (realized over invested in companies with positive realized cash)",
3132
+ "nullable": true
3133
+ },
3123
3134
  "ownership": {
3124
3135
  "type": "number",
3125
3136
  "description": "Aggregate ownership percentage",
@@ -5386,39 +5397,85 @@
5386
5397
  "meta"
5387
5398
  ]
5388
5399
  },
5389
- "SdkCompanyReportsListResponseDto": {
5400
+ "SdkReportSectionType": {
5401
+ "type": "string",
5402
+ "enum": [
5403
+ "text"
5404
+ ],
5405
+ "description": "Plain-text section."
5406
+ },
5407
+ "SdkTextReportSectionDto": {
5390
5408
  "type": "object",
5391
5409
  "properties": {
5392
- "data": {
5393
- "type": "array",
5394
- "items": {
5395
- "$ref": "#/components/schemas/SdkCompanyReportSummaryDto"
5396
- }
5410
+ "id": {
5411
+ "type": "number",
5412
+ "description": "Section identifier."
5397
5413
  },
5398
- "meta": {
5399
- "$ref": "#/components/schemas/SdkPaginationMetaDto"
5414
+ "type": {
5415
+ "description": "Plain-text section.",
5416
+ "allOf": [
5417
+ {
5418
+ "$ref": "#/components/schemas/SdkReportSectionType"
5419
+ }
5420
+ ]
5421
+ },
5422
+ "order": {
5423
+ "type": "number",
5424
+ "description": "Position of the section within the report (0-based)."
5425
+ },
5426
+ "title": {
5427
+ "type": "string",
5428
+ "description": "Section title."
5429
+ },
5430
+ "content": {
5431
+ "type": "string",
5432
+ "description": "Plain-text body.",
5433
+ "nullable": true
5400
5434
  }
5401
5435
  },
5402
5436
  "required": [
5403
- "data",
5404
- "meta"
5437
+ "id",
5438
+ "type",
5439
+ "order",
5440
+ "title",
5441
+ "content"
5405
5442
  ]
5406
5443
  },
5407
- "SdkUserReferenceDto": {
5444
+ "SdkMarkdownReportSectionDto": {
5408
5445
  "type": "object",
5409
5446
  "properties": {
5410
5447
  "id": {
5411
5448
  "type": "number",
5412
- "description": "User identifier."
5449
+ "description": "Section identifier."
5413
5450
  },
5414
- "name": {
5451
+ "type": {
5452
+ "description": "Markdown section.",
5453
+ "allOf": [
5454
+ {
5455
+ "$ref": "#/components/schemas/SdkReportSectionType"
5456
+ }
5457
+ ]
5458
+ },
5459
+ "order": {
5460
+ "type": "number",
5461
+ "description": "Position of the section within the report (0-based)."
5462
+ },
5463
+ "title": {
5415
5464
  "type": "string",
5416
- "description": "User display name (first + last name)."
5465
+ "description": "Section title."
5466
+ },
5467
+ "content": {
5468
+ "type": "string",
5469
+ "description": "Markdown body.",
5470
+ "nullable": true
5417
5471
  }
5418
5472
  },
5419
5473
  "required": [
5420
5474
  "id",
5421
- "name"
5475
+ "type",
5476
+ "order",
5477
+ "title",
5478
+ "content"
5422
5479
  ]
5423
5480
  },
5424
5481
  "SdkCompanyReportAttachmentDto": {
@@ -5440,10 +5497,11 @@
5440
5497
  },
5441
5498
  "required": [
5442
5499
  "id",
5443
- "name"
5500
+ "name",
5501
+ "url"
5444
5502
  ]
5445
5503
  },
5446
- "SdkCompanyReportSectionDto": {
5504
+ "SdkImageReportSectionDto": {
5447
5505
  "type": "object",
5448
5506
  "properties": {
5449
5507
  "id": {
@@ -5451,8 +5509,12 @@
5451
5509
  "description": "Section identifier."
5452
5510
  },
5453
5511
  "type": {
5454
- "type": "object",
5455
- "description": "Section type."
5512
+ "description": "Image section.",
5513
+ "allOf": [
5514
+ {
5515
+ "$ref": "#/components/schemas/SdkReportSectionType"
5516
+ }
5517
+ ]
5456
5518
  },
5457
5519
  "order": {
5458
5520
  "type": "number",
@@ -5462,13 +5524,13 @@
5462
5524
  "type": "string",
5463
5525
  "description": "Section title."
5464
5526
  },
5465
- "content": {
5527
+ "imageUrl": {
5466
5528
  "type": "string",
5467
- "description": "Section body. Plain text for Text sections, Markdown for Markdown sections.",
5529
+ "description": "Pre-signed, time-limited link to the image.",
5468
5530
  "nullable": true
5469
5531
  },
5470
5532
  "file": {
5471
- "description": "Attached file for File-typed sections.",
5533
+ "description": "The underlying uploaded image file.",
5472
5534
  "nullable": true,
5473
5535
  "type": "object",
5474
5536
  "allOf": [
@@ -5476,18 +5538,216 @@
5476
5538
  "$ref": "#/components/schemas/SdkCompanyReportAttachmentDto"
5477
5539
  }
5478
5540
  ]
5541
+ }
5542
+ },
5543
+ "required": [
5544
+ "id",
5545
+ "type",
5546
+ "order",
5547
+ "title",
5548
+ "imageUrl",
5549
+ "file"
5550
+ ]
5551
+ },
5552
+ "SdkChartReportSectionDto": {
5553
+ "type": "object",
5554
+ "properties": {
5555
+ "id": {
5556
+ "type": "number",
5557
+ "description": "Section identifier."
5479
5558
  },
5480
- "imageUrl": {
5559
+ "type": {
5560
+ "description": "Dynamically rendered chart section.",
5561
+ "allOf": [
5562
+ {
5563
+ "$ref": "#/components/schemas/SdkReportSectionType"
5564
+ }
5565
+ ]
5566
+ },
5567
+ "order": {
5568
+ "type": "number",
5569
+ "description": "Position of the section within the report (0-based)."
5570
+ },
5571
+ "title": {
5481
5572
  "type": "string",
5482
- "description": "Embedded image URL for Image sections (pre-signed, time-limited).",
5483
- "nullable": true
5573
+ "description": "Section title."
5574
+ },
5575
+ "content": {
5576
+ "type": "object",
5577
+ "description": "Versioned, materialized chart data and display configuration."
5484
5578
  }
5485
5579
  },
5486
5580
  "required": [
5487
5581
  "id",
5488
5582
  "type",
5489
5583
  "order",
5490
- "title"
5584
+ "title",
5585
+ "content"
5586
+ ]
5587
+ },
5588
+ "SdkTableReportSectionDto": {
5589
+ "type": "object",
5590
+ "properties": {
5591
+ "id": {
5592
+ "type": "number",
5593
+ "description": "Section identifier."
5594
+ },
5595
+ "type": {
5596
+ "description": "Dynamically rendered table section.",
5597
+ "allOf": [
5598
+ {
5599
+ "$ref": "#/components/schemas/SdkReportSectionType"
5600
+ }
5601
+ ]
5602
+ },
5603
+ "order": {
5604
+ "type": "number",
5605
+ "description": "Position of the section within the report (0-based)."
5606
+ },
5607
+ "title": {
5608
+ "type": "string",
5609
+ "description": "Section title."
5610
+ },
5611
+ "content": {
5612
+ "type": "object",
5613
+ "description": "Versioned, materialized table data."
5614
+ }
5615
+ },
5616
+ "required": [
5617
+ "id",
5618
+ "type",
5619
+ "order",
5620
+ "title",
5621
+ "content"
5622
+ ]
5623
+ },
5624
+ "SdkSingleChoiceReportSectionDto": {
5625
+ "type": "object",
5626
+ "properties": {
5627
+ "id": {
5628
+ "type": "number",
5629
+ "description": "Section identifier."
5630
+ },
5631
+ "type": {
5632
+ "description": "Single-choice section.",
5633
+ "allOf": [
5634
+ {
5635
+ "$ref": "#/components/schemas/SdkReportSectionType"
5636
+ }
5637
+ ]
5638
+ },
5639
+ "order": {
5640
+ "type": "number",
5641
+ "description": "Position of the section within the report (0-based)."
5642
+ },
5643
+ "title": {
5644
+ "type": "string",
5645
+ "description": "Section title."
5646
+ },
5647
+ "options": {
5648
+ "description": "All selectable option labels, in human-readable form.",
5649
+ "type": "array",
5650
+ "items": {
5651
+ "type": "string"
5652
+ }
5653
+ },
5654
+ "selectedOptions": {
5655
+ "description": "The selected option label(s), in human-readable form.",
5656
+ "type": "array",
5657
+ "items": {
5658
+ "type": "string"
5659
+ }
5660
+ }
5661
+ },
5662
+ "required": [
5663
+ "id",
5664
+ "type",
5665
+ "order",
5666
+ "title",
5667
+ "options",
5668
+ "selectedOptions"
5669
+ ]
5670
+ },
5671
+ "SdkMultiChoiceReportSectionDto": {
5672
+ "type": "object",
5673
+ "properties": {
5674
+ "id": {
5675
+ "type": "number",
5676
+ "description": "Section identifier."
5677
+ },
5678
+ "type": {
5679
+ "description": "Multi-choice section.",
5680
+ "allOf": [
5681
+ {
5682
+ "$ref": "#/components/schemas/SdkReportSectionType"
5683
+ }
5684
+ ]
5685
+ },
5686
+ "order": {
5687
+ "type": "number",
5688
+ "description": "Position of the section within the report (0-based)."
5689
+ },
5690
+ "title": {
5691
+ "type": "string",
5692
+ "description": "Section title."
5693
+ },
5694
+ "options": {
5695
+ "description": "All selectable option labels, in human-readable form.",
5696
+ "type": "array",
5697
+ "items": {
5698
+ "type": "string"
5699
+ }
5700
+ },
5701
+ "selectedOptions": {
5702
+ "description": "The selected option label(s), in human-readable form.",
5703
+ "type": "array",
5704
+ "items": {
5705
+ "type": "string"
5706
+ }
5707
+ }
5708
+ },
5709
+ "required": [
5710
+ "id",
5711
+ "type",
5712
+ "order",
5713
+ "title",
5714
+ "options",
5715
+ "selectedOptions"
5716
+ ]
5717
+ },
5718
+ "SdkCompanyReportsListResponseDto": {
5719
+ "type": "object",
5720
+ "properties": {
5721
+ "data": {
5722
+ "type": "array",
5723
+ "items": {
5724
+ "$ref": "#/components/schemas/SdkCompanyReportSummaryDto"
5725
+ }
5726
+ },
5727
+ "meta": {
5728
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
5729
+ }
5730
+ },
5731
+ "required": [
5732
+ "data",
5733
+ "meta"
5734
+ ]
5735
+ },
5736
+ "SdkUserReferenceDto": {
5737
+ "type": "object",
5738
+ "properties": {
5739
+ "id": {
5740
+ "type": "number",
5741
+ "description": "User identifier."
5742
+ },
5743
+ "name": {
5744
+ "type": "string",
5745
+ "description": "User display name (first + last name)."
5746
+ }
5747
+ },
5748
+ "required": [
5749
+ "id",
5750
+ "name"
5491
5751
  ]
5492
5752
  },
5493
5753
  "SdkCompanyReportDto": {
@@ -5533,10 +5793,44 @@
5533
5793
  ]
5534
5794
  },
5535
5795
  "sections": {
5536
- "description": "Structured sections that compose the report body.",
5537
5796
  "type": "array",
5797
+ "description": "Structured sections that compose the report body. Each element is a section variant; narrow via its `type` field.",
5538
5798
  "items": {
5539
- "$ref": "#/components/schemas/SdkCompanyReportSectionDto"
5799
+ "oneOf": [
5800
+ {
5801
+ "$ref": "#/components/schemas/SdkTextReportSectionDto"
5802
+ },
5803
+ {
5804
+ "$ref": "#/components/schemas/SdkMarkdownReportSectionDto"
5805
+ },
5806
+ {
5807
+ "$ref": "#/components/schemas/SdkImageReportSectionDto"
5808
+ },
5809
+ {
5810
+ "$ref": "#/components/schemas/SdkChartReportSectionDto"
5811
+ },
5812
+ {
5813
+ "$ref": "#/components/schemas/SdkTableReportSectionDto"
5814
+ },
5815
+ {
5816
+ "$ref": "#/components/schemas/SdkSingleChoiceReportSectionDto"
5817
+ },
5818
+ {
5819
+ "$ref": "#/components/schemas/SdkMultiChoiceReportSectionDto"
5820
+ }
5821
+ ],
5822
+ "discriminator": {
5823
+ "propertyName": "type",
5824
+ "mapping": {
5825
+ "text": "#/components/schemas/SdkTextReportSectionDto",
5826
+ "markdown": "#/components/schemas/SdkMarkdownReportSectionDto",
5827
+ "image": "#/components/schemas/SdkImageReportSectionDto",
5828
+ "chart": "#/components/schemas/SdkChartReportSectionDto",
5829
+ "table": "#/components/schemas/SdkTableReportSectionDto",
5830
+ "single-choice": "#/components/schemas/SdkSingleChoiceReportSectionDto",
5831
+ "multi-choice": "#/components/schemas/SdkMultiChoiceReportSectionDto"
5832
+ }
5833
+ }
5540
5834
  }
5541
5835
  },
5542
5836
  "attachments": {
@@ -5552,7 +5846,9 @@
5552
5846
  "title",
5553
5847
  "date",
5554
5848
  "timeframe",
5849
+ "publishedAt",
5555
5850
  "company",
5851
+ "createdBy",
5556
5852
  "sections",
5557
5853
  "attachments"
5558
5854
  ]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rundit-sdk/embed",
3
- "version": "0.3.1",
3
+ "version": "0.3.3",
4
4
  "description": "Public Rundit embed SDK for iframe and embedded module consumers.",
5
5
  "repository": {
6
6
  "type": "git",