@rundit-sdk/embed 0.3.0-rc.3 → 0.3.1-rc.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.
package/dist/index.d.ts CHANGED
@@ -359,7 +359,7 @@ export interface SdkCompanyReportSummaryDto {
359
359
  title: string
360
360
  date: string
361
361
  timeframe: { }
362
- publishedAt?: string | null
362
+ publishedAt: string | null
363
363
  company: SdkCompanyReferenceDto
364
364
  }
365
365
 
@@ -698,20 +698,55 @@ export interface SdkUserReferenceDto {
698
698
  name: string
699
699
  }
700
700
 
701
+ export type SdkReportSectionType = "text"
702
+
703
+ export interface SdkTextReportSectionDto {
704
+ id: number
705
+ type: SdkReportSectionType
706
+ order: number
707
+ title: string
708
+ content: string | null
709
+ }
710
+
711
+ export interface SdkMarkdownReportSectionDto {
712
+ id: number
713
+ type: SdkReportSectionType
714
+ order: number
715
+ title: string
716
+ content: string | null
717
+ }
718
+
701
719
  export interface SdkCompanyReportAttachmentDto {
702
720
  id: number
703
721
  name: string
704
- url?: string | null
722
+ url: string | null
723
+ }
724
+
725
+ export interface SdkImageReportSectionDto {
726
+ id: number
727
+ type: SdkReportSectionType
728
+ order: number
729
+ title: string
730
+ imageUrl: string | null
731
+ file: SdkCompanyReportAttachmentDto
732
+ }
733
+
734
+ export interface SdkSingleChoiceReportSectionDto {
735
+ id: number
736
+ type: SdkReportSectionType
737
+ order: number
738
+ title: string
739
+ options: string[]
740
+ selectedOptions: string[]
705
741
  }
706
742
 
707
- export interface SdkCompanyReportSectionDto {
743
+ export interface SdkMultiChoiceReportSectionDto {
708
744
  id: number
709
- type: { }
745
+ type: SdkReportSectionType
710
746
  order: number
711
747
  title: string
712
- content?: string | null
713
- file?: SdkCompanyReportAttachmentDto
714
- imageUrl?: string | null
748
+ options: string[]
749
+ selectedOptions: string[]
715
750
  }
716
751
 
717
752
  export interface SdkCompanyReportDto {
@@ -719,10 +754,10 @@ export interface SdkCompanyReportDto {
719
754
  title: string
720
755
  date: string
721
756
  timeframe: { }
722
- publishedAt?: string | null
757
+ publishedAt: string | null
723
758
  company: SdkCompanyReferenceDto
724
- createdBy?: SdkUserReferenceDto
725
- sections: SdkCompanyReportSectionDto[]
759
+ createdBy: SdkUserReferenceDto
760
+ sections: (SdkTextReportSectionDto | SdkMarkdownReportSectionDto | SdkImageReportSectionDto | SdkSingleChoiceReportSectionDto | SdkMultiChoiceReportSectionDto)[]
726
761
  attachments: SdkCompanyReportAttachmentDto[]
727
762
  }
728
763
 
package/openapi.json CHANGED
@@ -2392,6 +2392,7 @@
2392
2392
  "title",
2393
2393
  "date",
2394
2394
  "timeframe",
2395
+ "publishedAt",
2395
2396
  "company"
2396
2397
  ]
2397
2398
  },
@@ -5386,39 +5387,85 @@
5386
5387
  "meta"
5387
5388
  ]
5388
5389
  },
5389
- "SdkCompanyReportsListResponseDto": {
5390
+ "SdkReportSectionType": {
5391
+ "type": "string",
5392
+ "enum": [
5393
+ "text"
5394
+ ],
5395
+ "description": "Plain-text section."
5396
+ },
5397
+ "SdkTextReportSectionDto": {
5390
5398
  "type": "object",
5391
5399
  "properties": {
5392
- "data": {
5393
- "type": "array",
5394
- "items": {
5395
- "$ref": "#/components/schemas/SdkCompanyReportSummaryDto"
5396
- }
5400
+ "id": {
5401
+ "type": "number",
5402
+ "description": "Section identifier."
5397
5403
  },
5398
- "meta": {
5399
- "$ref": "#/components/schemas/SdkPaginationMetaDto"
5404
+ "type": {
5405
+ "description": "Plain-text section.",
5406
+ "allOf": [
5407
+ {
5408
+ "$ref": "#/components/schemas/SdkReportSectionType"
5409
+ }
5410
+ ]
5411
+ },
5412
+ "order": {
5413
+ "type": "number",
5414
+ "description": "Position of the section within the report (0-based)."
5415
+ },
5416
+ "title": {
5417
+ "type": "string",
5418
+ "description": "Section title."
5419
+ },
5420
+ "content": {
5421
+ "type": "string",
5422
+ "description": "Plain-text body.",
5423
+ "nullable": true
5400
5424
  }
5401
5425
  },
5402
5426
  "required": [
5403
- "data",
5404
- "meta"
5427
+ "id",
5428
+ "type",
5429
+ "order",
5430
+ "title",
5431
+ "content"
5405
5432
  ]
5406
5433
  },
5407
- "SdkUserReferenceDto": {
5434
+ "SdkMarkdownReportSectionDto": {
5408
5435
  "type": "object",
5409
5436
  "properties": {
5410
5437
  "id": {
5411
5438
  "type": "number",
5412
- "description": "User identifier."
5439
+ "description": "Section identifier."
5413
5440
  },
5414
- "name": {
5441
+ "type": {
5442
+ "description": "Markdown section.",
5443
+ "allOf": [
5444
+ {
5445
+ "$ref": "#/components/schemas/SdkReportSectionType"
5446
+ }
5447
+ ]
5448
+ },
5449
+ "order": {
5450
+ "type": "number",
5451
+ "description": "Position of the section within the report (0-based)."
5452
+ },
5453
+ "title": {
5415
5454
  "type": "string",
5416
- "description": "User display name (first + last name)."
5455
+ "description": "Section title."
5456
+ },
5457
+ "content": {
5458
+ "type": "string",
5459
+ "description": "Markdown body.",
5460
+ "nullable": true
5417
5461
  }
5418
5462
  },
5419
5463
  "required": [
5420
5464
  "id",
5421
- "name"
5465
+ "type",
5466
+ "order",
5467
+ "title",
5468
+ "content"
5422
5469
  ]
5423
5470
  },
5424
5471
  "SdkCompanyReportAttachmentDto": {
@@ -5440,10 +5487,11 @@
5440
5487
  },
5441
5488
  "required": [
5442
5489
  "id",
5443
- "name"
5490
+ "name",
5491
+ "url"
5444
5492
  ]
5445
5493
  },
5446
- "SdkCompanyReportSectionDto": {
5494
+ "SdkImageReportSectionDto": {
5447
5495
  "type": "object",
5448
5496
  "properties": {
5449
5497
  "id": {
@@ -5451,8 +5499,12 @@
5451
5499
  "description": "Section identifier."
5452
5500
  },
5453
5501
  "type": {
5454
- "type": "object",
5455
- "description": "Section type."
5502
+ "description": "Image section.",
5503
+ "allOf": [
5504
+ {
5505
+ "$ref": "#/components/schemas/SdkReportSectionType"
5506
+ }
5507
+ ]
5456
5508
  },
5457
5509
  "order": {
5458
5510
  "type": "number",
@@ -5462,13 +5514,13 @@
5462
5514
  "type": "string",
5463
5515
  "description": "Section title."
5464
5516
  },
5465
- "content": {
5517
+ "imageUrl": {
5466
5518
  "type": "string",
5467
- "description": "Section body. Plain text for Text sections, Markdown for Markdown sections.",
5519
+ "description": "Pre-signed, time-limited link to the image.",
5468
5520
  "nullable": true
5469
5521
  },
5470
5522
  "file": {
5471
- "description": "Attached file for File-typed sections.",
5523
+ "description": "The underlying uploaded image file.",
5472
5524
  "nullable": true,
5473
5525
  "type": "object",
5474
5526
  "allOf": [
@@ -5476,18 +5528,144 @@
5476
5528
  "$ref": "#/components/schemas/SdkCompanyReportAttachmentDto"
5477
5529
  }
5478
5530
  ]
5531
+ }
5532
+ },
5533
+ "required": [
5534
+ "id",
5535
+ "type",
5536
+ "order",
5537
+ "title",
5538
+ "imageUrl",
5539
+ "file"
5540
+ ]
5541
+ },
5542
+ "SdkSingleChoiceReportSectionDto": {
5543
+ "type": "object",
5544
+ "properties": {
5545
+ "id": {
5546
+ "type": "number",
5547
+ "description": "Section identifier."
5479
5548
  },
5480
- "imageUrl": {
5549
+ "type": {
5550
+ "description": "Single-choice section.",
5551
+ "allOf": [
5552
+ {
5553
+ "$ref": "#/components/schemas/SdkReportSectionType"
5554
+ }
5555
+ ]
5556
+ },
5557
+ "order": {
5558
+ "type": "number",
5559
+ "description": "Position of the section within the report (0-based)."
5560
+ },
5561
+ "title": {
5481
5562
  "type": "string",
5482
- "description": "Embedded image URL for Image sections (pre-signed, time-limited).",
5483
- "nullable": true
5563
+ "description": "Section title."
5564
+ },
5565
+ "options": {
5566
+ "description": "All selectable option labels, in human-readable form.",
5567
+ "type": "array",
5568
+ "items": {
5569
+ "type": "string"
5570
+ }
5571
+ },
5572
+ "selectedOptions": {
5573
+ "description": "The selected option label(s), in human-readable form.",
5574
+ "type": "array",
5575
+ "items": {
5576
+ "type": "string"
5577
+ }
5484
5578
  }
5485
5579
  },
5486
5580
  "required": [
5487
5581
  "id",
5488
5582
  "type",
5489
5583
  "order",
5490
- "title"
5584
+ "title",
5585
+ "options",
5586
+ "selectedOptions"
5587
+ ]
5588
+ },
5589
+ "SdkMultiChoiceReportSectionDto": {
5590
+ "type": "object",
5591
+ "properties": {
5592
+ "id": {
5593
+ "type": "number",
5594
+ "description": "Section identifier."
5595
+ },
5596
+ "type": {
5597
+ "description": "Multi-choice section.",
5598
+ "allOf": [
5599
+ {
5600
+ "$ref": "#/components/schemas/SdkReportSectionType"
5601
+ }
5602
+ ]
5603
+ },
5604
+ "order": {
5605
+ "type": "number",
5606
+ "description": "Position of the section within the report (0-based)."
5607
+ },
5608
+ "title": {
5609
+ "type": "string",
5610
+ "description": "Section title."
5611
+ },
5612
+ "options": {
5613
+ "description": "All selectable option labels, in human-readable form.",
5614
+ "type": "array",
5615
+ "items": {
5616
+ "type": "string"
5617
+ }
5618
+ },
5619
+ "selectedOptions": {
5620
+ "description": "The selected option label(s), in human-readable form.",
5621
+ "type": "array",
5622
+ "items": {
5623
+ "type": "string"
5624
+ }
5625
+ }
5626
+ },
5627
+ "required": [
5628
+ "id",
5629
+ "type",
5630
+ "order",
5631
+ "title",
5632
+ "options",
5633
+ "selectedOptions"
5634
+ ]
5635
+ },
5636
+ "SdkCompanyReportsListResponseDto": {
5637
+ "type": "object",
5638
+ "properties": {
5639
+ "data": {
5640
+ "type": "array",
5641
+ "items": {
5642
+ "$ref": "#/components/schemas/SdkCompanyReportSummaryDto"
5643
+ }
5644
+ },
5645
+ "meta": {
5646
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
5647
+ }
5648
+ },
5649
+ "required": [
5650
+ "data",
5651
+ "meta"
5652
+ ]
5653
+ },
5654
+ "SdkUserReferenceDto": {
5655
+ "type": "object",
5656
+ "properties": {
5657
+ "id": {
5658
+ "type": "number",
5659
+ "description": "User identifier."
5660
+ },
5661
+ "name": {
5662
+ "type": "string",
5663
+ "description": "User display name (first + last name)."
5664
+ }
5665
+ },
5666
+ "required": [
5667
+ "id",
5668
+ "name"
5491
5669
  ]
5492
5670
  },
5493
5671
  "SdkCompanyReportDto": {
@@ -5533,10 +5711,36 @@
5533
5711
  ]
5534
5712
  },
5535
5713
  "sections": {
5536
- "description": "Structured sections that compose the report body.",
5537
5714
  "type": "array",
5715
+ "description": "Structured sections that compose the report body. Each element is a section variant; narrow via its `type` field.",
5538
5716
  "items": {
5539
- "$ref": "#/components/schemas/SdkCompanyReportSectionDto"
5717
+ "oneOf": [
5718
+ {
5719
+ "$ref": "#/components/schemas/SdkTextReportSectionDto"
5720
+ },
5721
+ {
5722
+ "$ref": "#/components/schemas/SdkMarkdownReportSectionDto"
5723
+ },
5724
+ {
5725
+ "$ref": "#/components/schemas/SdkImageReportSectionDto"
5726
+ },
5727
+ {
5728
+ "$ref": "#/components/schemas/SdkSingleChoiceReportSectionDto"
5729
+ },
5730
+ {
5731
+ "$ref": "#/components/schemas/SdkMultiChoiceReportSectionDto"
5732
+ }
5733
+ ],
5734
+ "discriminator": {
5735
+ "propertyName": "type",
5736
+ "mapping": {
5737
+ "text": "#/components/schemas/SdkTextReportSectionDto",
5738
+ "markdown": "#/components/schemas/SdkMarkdownReportSectionDto",
5739
+ "image": "#/components/schemas/SdkImageReportSectionDto",
5740
+ "single-choice": "#/components/schemas/SdkSingleChoiceReportSectionDto",
5741
+ "multi-choice": "#/components/schemas/SdkMultiChoiceReportSectionDto"
5742
+ }
5743
+ }
5540
5744
  }
5541
5745
  },
5542
5746
  "attachments": {
@@ -5552,7 +5756,9 @@
5552
5756
  "title",
5553
5757
  "date",
5554
5758
  "timeframe",
5759
+ "publishedAt",
5555
5760
  "company",
5761
+ "createdBy",
5556
5762
  "sections",
5557
5763
  "attachments"
5558
5764
  ]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rundit-sdk/embed",
3
- "version": "0.3.0-rc.3",
3
+ "version": "0.3.1-rc.5",
4
4
  "description": "Public Rundit embed SDK for iframe and embedded module consumers.",
5
5
  "repository": {
6
6
  "type": "git",