@inneropen/marvin-sdk 2.0.0-next.3 → 2.0.0-next.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 (3) hide show
  1. package/dist/platform.d.cts +107 -65
  2. package/dist/platform.d.ts +107 -65
  3. package/package.json +1 -1
package/dist/platform.d.cts CHANGED
@@ -646,6 +646,9 @@ interface components {
646
646
  /**
647
647
  * EntryCreate
648
648
  * @description Schema for creating an entry.
649
+ *
650
+ * BREAKING CHANGE: content_markdown removed, replaced with data_json.
651
+ * Entry content is now schema-driven based on entry_type.schema_json.
649
652
  */
650
653
  EntryCreate: {
651
654
  /**
@@ -661,8 +664,13 @@ interface components {
661
664
  summary?: string | null;
662
665
  /** Description */
663
666
  description?: string | null;
664
- /** Contentmarkdown */
665
- contentMarkdown?: string | null;
667
+ /**
668
+ * Datajson
669
+ * @description Schema-driven content data (validated against entry_type.schema_json)
670
+ */
671
+ dataJson?: {
672
+ [key: string]: unknown;
673
+ };
666
674
  /**
667
675
  * Status
668
676
  * @default inbox
@@ -674,7 +682,10 @@ interface components {
674
682
  publishAt?: string | null;
675
683
  /** Expireat */
676
684
  expireAt?: string | null;
677
- /** Metadatajson */
685
+ /**
686
+ * Metadatajson
687
+ * @description Custom non-schema metadata (API keys, external IDs, etc.)
688
+ */
678
689
  metadataJson?: {
679
690
  [key: string]: unknown;
680
691
  } | null;
@@ -701,6 +712,9 @@ interface components {
701
712
  /**
702
713
  * EntryRead
703
714
  * @description Schema for reading an entry.
715
+ *
716
+ * BREAKING CHANGE: content_markdown removed, replaced with data_json.
717
+ * Entry content is now schema-driven based on entry_type.schema_json.
704
718
  */
705
719
  EntryRead: {
706
720
  /**
@@ -726,8 +740,13 @@ interface components {
726
740
  summary?: string | null;
727
741
  /** Description */
728
742
  description?: string | null;
729
- /** Contentmarkdown */
730
- contentMarkdown?: string | null;
743
+ /**
744
+ * Datajson
745
+ * @description Schema-driven content data
746
+ */
747
+ dataJson?: {
748
+ [key: string]: unknown;
749
+ };
731
750
  /** Status */
732
751
  status: string;
733
752
  /** Publishedat */
@@ -736,7 +755,10 @@ interface components {
736
755
  publishAt?: string | null;
737
756
  /** Expireat */
738
757
  expireAt?: string | null;
739
- /** Metadatajson */
758
+ /**
759
+ * Metadatajson
760
+ * @description Custom non-schema metadata
761
+ */
740
762
  metadataJson?: {
741
763
  [key: string]: unknown;
742
764
  } | null;
@@ -789,10 +811,20 @@ interface components {
789
811
  * @default false
790
812
  */
791
813
  isSystem: boolean;
814
+ /**
815
+ * Schema Json
816
+ * @description Entry type schema definition (EntryTypeSchemaDefinition)
817
+ */
818
+ schema_json?: {
819
+ [key: string]: unknown;
820
+ } | null;
792
821
  };
793
822
  /**
794
823
  * EntryTypeRead
795
824
  * @description Schema for reading an entry type.
825
+ *
826
+ * System entry types have group_id=None and are globally available to all workspaces.
827
+ * Workspace-scoped entry types have a specific group_id.
796
828
  */
797
829
  EntryTypeRead: {
798
830
  /**
@@ -800,11 +832,8 @@ interface components {
800
832
  * Format: uuid4
801
833
  */
802
834
  id: string;
803
- /**
804
- * Groupid
805
- * Format: uuid4
806
- */
807
- groupId: string;
835
+ /** Groupid */
836
+ groupId: string | null;
808
837
  /** Name */
809
838
  name: string;
810
839
  /** Slug */
@@ -819,6 +848,13 @@ interface components {
819
848
  sortOrder: number;
820
849
  /** Issystem */
821
850
  isSystem: boolean;
851
+ /**
852
+ * Schemajson
853
+ * @description Entry type schema definition (EntryTypeSchemaDefinition)
854
+ */
855
+ schemaJson?: {
856
+ [key: string]: unknown;
857
+ } | null;
822
858
  /** Createdat */
823
859
  createdAt?: string | null;
824
860
  /** Updateat */
@@ -843,10 +879,20 @@ interface components {
843
879
  sortOrder?: number | null;
844
880
  /** Issystem */
845
881
  isSystem?: boolean | null;
882
+ /**
883
+ * Schema Json
884
+ * @description Entry type schema definition (EntryTypeSchemaDefinition)
885
+ */
886
+ schema_json?: {
887
+ [key: string]: unknown;
888
+ } | null;
846
889
  };
847
890
  /**
848
891
  * EntryUpdate
849
892
  * @description Schema for patching an entry.
893
+ *
894
+ * BREAKING CHANGE: content_markdown removed, replaced with data_json.
895
+ * Entry content is now schema-driven based on entry_type.schema_json.
850
896
  */
851
897
  EntryUpdate: {
852
898
  /** Entry Type Id */
@@ -859,18 +905,26 @@ interface components {
859
905
  summary?: string | null;
860
906
  /** Description */
861
907
  description?: string | null;
862
- /** Content Markdown */
863
- content_markdown?: string | null;
908
+ /**
909
+ * Datajson
910
+ * @description Schema-driven content data (validated against entry_type.schema_json)
911
+ */
912
+ dataJson?: {
913
+ [key: string]: unknown;
914
+ } | null;
864
915
  /** Status */
865
916
  status?: string | null;
866
- /** Published At */
867
- published_at?: string | null;
868
- /** Publish At */
869
- publish_at?: string | null;
870
- /** Expire At */
871
- expire_at?: string | null;
872
- /** Metadata Json */
873
- metadata_json?: {
917
+ /** Publishedat */
918
+ publishedAt?: string | null;
919
+ /** Publishat */
920
+ publishAt?: string | null;
921
+ /** Expireat */
922
+ expireAt?: string | null;
923
+ /**
924
+ * Metadatajson
925
+ * @description Custom non-schema metadata (API keys, external IDs, etc.)
926
+ */
927
+ metadataJson?: {
874
928
  [key: string]: unknown;
875
929
  } | null;
876
930
  /** Collection Ids */
@@ -1630,15 +1684,10 @@ interface components {
1630
1684
  description?: string | null;
1631
1685
  /** Publicurl */
1632
1686
  publicUrl: string;
1633
- /** Metadata */
1634
- metadata?: {
1687
+ /** Metadatajson */
1688
+ metadataJson?: {
1635
1689
  [key: string]: unknown;
1636
1690
  } | null;
1637
- /**
1638
- * Entries
1639
- * @default []
1640
- */
1641
- entries: string[];
1642
1691
  };
1643
1692
  /**
1644
1693
  * PublishedAssetsResponse
@@ -1671,8 +1720,8 @@ interface components {
1671
1720
  smartRules?: {
1672
1721
  [key: string]: unknown;
1673
1722
  } | null;
1674
- /** Metadata */
1675
- metadata?: {
1723
+ /** Metadatajson */
1724
+ metadataJson?: {
1676
1725
  [key: string]: unknown;
1677
1726
  } | null;
1678
1727
  /** Entrycount */
@@ -1683,35 +1732,21 @@ interface components {
1683
1732
  /**
1684
1733
  * PublishedCollectionSummary
1685
1734
  * @description Summary schema for published collections (for listing).
1735
+ *
1736
+ * Minimal collection info for entry contexts - only includes
1737
+ * essential fields for display and ordering.
1686
1738
  */
1687
1739
  PublishedCollectionSummary: {
1688
1740
  /** Slug */
1689
1741
  slug: string;
1690
1742
  /** Name */
1691
1743
  name: string;
1692
- /** Description */
1693
- description?: string | null;
1694
- /**
1695
- * Issmart
1696
- * @default false
1697
- */
1698
- isSmart: boolean;
1699
- /** Smartrules */
1700
- smartRules?: {
1701
- [key: string]: unknown;
1702
- } | null;
1703
- /** Metadata */
1704
- metadata?: {
1744
+ /** Metadatajson */
1745
+ metadataJson?: {
1705
1746
  [key: string]: unknown;
1706
1747
  } | null;
1707
- /** Entrycount */
1708
- entryCount: number;
1709
1748
  /** Sortorder */
1710
1749
  sortOrder: number;
1711
- /** Icon */
1712
- icon?: string | null;
1713
- /** Color */
1714
- color?: string | null;
1715
1750
  };
1716
1751
  /**
1717
1752
  * PublishedCollectionsResponse
@@ -1749,23 +1784,25 @@ interface components {
1749
1784
  summary?: string | null;
1750
1785
  /** Publishedat */
1751
1786
  publishedAt?: string | null;
1787
+ /** Status */
1788
+ status: string;
1752
1789
  /**
1753
1790
  * Collections
1754
1791
  * @default []
1755
1792
  */
1756
1793
  collections: string[];
1757
1794
  /**
1758
- * Assets
1795
+ * Assetslugs
1759
1796
  * @default []
1760
1797
  */
1761
- assets: string[];
1762
- /** Order */
1763
- order?: number | null;
1798
+ assetSlugs: string[];
1764
1799
  /**
1765
- * Resources
1800
+ * Resourceslugs
1766
1801
  * @default []
1767
1802
  */
1768
- resources: string[];
1803
+ resourceSlugs: string[];
1804
+ /** Order */
1805
+ order?: number | null;
1769
1806
  };
1770
1807
  /**
1771
1808
  * PublishedEntryRead
@@ -1773,6 +1810,9 @@ interface components {
1773
1810
  *
1774
1811
  * Only includes public-facing fields. Excludes all admin metadata,
1775
1812
  * internal fields, and user information.
1813
+ *
1814
+ * BREAKING CHANGE: content_markdown removed, replaced with data.
1815
+ * Entry content is now schema-driven based on entry_type.schema_json.
1776
1816
  */
1777
1817
  PublishedEntryRead: {
1778
1818
  /** Slug */
@@ -1783,12 +1823,14 @@ interface components {
1783
1823
  entryType: string;
1784
1824
  /** Summary */
1785
1825
  summary?: string | null;
1786
- /** Contentmarkdown */
1787
- contentMarkdown?: string | null;
1826
+ /** Data */
1827
+ data: {
1828
+ [key: string]: unknown;
1829
+ };
1788
1830
  /** Publishedat */
1789
1831
  publishedAt?: string | null;
1790
- /** Metadata */
1791
- metadata?: {
1832
+ /** Metadatajson */
1833
+ metadataJson?: {
1792
1834
  [key: string]: unknown;
1793
1835
  } | null;
1794
1836
  /**
@@ -1828,8 +1870,8 @@ interface components {
1828
1870
  url?: string | null;
1829
1871
  /** Externalid */
1830
1872
  externalId?: string | null;
1831
- /** Metadata */
1832
- metadata?: {
1873
+ /** Metadatajson */
1874
+ metadataJson?: {
1833
1875
  [key: string]: unknown;
1834
1876
  } | null;
1835
1877
  /** Role */
@@ -1864,8 +1906,8 @@ interface components {
1864
1906
  url?: string | null;
1865
1907
  /** Externalid */
1866
1908
  externalId?: string | null;
1867
- /** Metadata */
1868
- metadata?: {
1909
+ /** Metadatajson */
1910
+ metadataJson?: {
1869
1911
  [key: string]: unknown;
1870
1912
  } | null;
1871
1913
  /**
@@ -2191,8 +2233,8 @@ interface components {
2191
2233
  social?: {
2192
2234
  [key: string]: unknown;
2193
2235
  } | null;
2194
- /** Metadata */
2195
- metadata?: {
2236
+ /** Metadatajson */
2237
+ metadataJson?: {
2196
2238
  [key: string]: unknown;
2197
2239
  } | null;
2198
2240
  };
package/dist/platform.d.ts CHANGED
@@ -646,6 +646,9 @@ interface components {
646
646
  /**
647
647
  * EntryCreate
648
648
  * @description Schema for creating an entry.
649
+ *
650
+ * BREAKING CHANGE: content_markdown removed, replaced with data_json.
651
+ * Entry content is now schema-driven based on entry_type.schema_json.
649
652
  */
650
653
  EntryCreate: {
651
654
  /**
@@ -661,8 +664,13 @@ interface components {
661
664
  summary?: string | null;
662
665
  /** Description */
663
666
  description?: string | null;
664
- /** Contentmarkdown */
665
- contentMarkdown?: string | null;
667
+ /**
668
+ * Datajson
669
+ * @description Schema-driven content data (validated against entry_type.schema_json)
670
+ */
671
+ dataJson?: {
672
+ [key: string]: unknown;
673
+ };
666
674
  /**
667
675
  * Status
668
676
  * @default inbox
@@ -674,7 +682,10 @@ interface components {
674
682
  publishAt?: string | null;
675
683
  /** Expireat */
676
684
  expireAt?: string | null;
677
- /** Metadatajson */
685
+ /**
686
+ * Metadatajson
687
+ * @description Custom non-schema metadata (API keys, external IDs, etc.)
688
+ */
678
689
  metadataJson?: {
679
690
  [key: string]: unknown;
680
691
  } | null;
@@ -701,6 +712,9 @@ interface components {
701
712
  /**
702
713
  * EntryRead
703
714
  * @description Schema for reading an entry.
715
+ *
716
+ * BREAKING CHANGE: content_markdown removed, replaced with data_json.
717
+ * Entry content is now schema-driven based on entry_type.schema_json.
704
718
  */
705
719
  EntryRead: {
706
720
  /**
@@ -726,8 +740,13 @@ interface components {
726
740
  summary?: string | null;
727
741
  /** Description */
728
742
  description?: string | null;
729
- /** Contentmarkdown */
730
- contentMarkdown?: string | null;
743
+ /**
744
+ * Datajson
745
+ * @description Schema-driven content data
746
+ */
747
+ dataJson?: {
748
+ [key: string]: unknown;
749
+ };
731
750
  /** Status */
732
751
  status: string;
733
752
  /** Publishedat */
@@ -736,7 +755,10 @@ interface components {
736
755
  publishAt?: string | null;
737
756
  /** Expireat */
738
757
  expireAt?: string | null;
739
- /** Metadatajson */
758
+ /**
759
+ * Metadatajson
760
+ * @description Custom non-schema metadata
761
+ */
740
762
  metadataJson?: {
741
763
  [key: string]: unknown;
742
764
  } | null;
@@ -789,10 +811,20 @@ interface components {
789
811
  * @default false
790
812
  */
791
813
  isSystem: boolean;
814
+ /**
815
+ * Schema Json
816
+ * @description Entry type schema definition (EntryTypeSchemaDefinition)
817
+ */
818
+ schema_json?: {
819
+ [key: string]: unknown;
820
+ } | null;
792
821
  };
793
822
  /**
794
823
  * EntryTypeRead
795
824
  * @description Schema for reading an entry type.
825
+ *
826
+ * System entry types have group_id=None and are globally available to all workspaces.
827
+ * Workspace-scoped entry types have a specific group_id.
796
828
  */
797
829
  EntryTypeRead: {
798
830
  /**
@@ -800,11 +832,8 @@ interface components {
800
832
  * Format: uuid4
801
833
  */
802
834
  id: string;
803
- /**
804
- * Groupid
805
- * Format: uuid4
806
- */
807
- groupId: string;
835
+ /** Groupid */
836
+ groupId: string | null;
808
837
  /** Name */
809
838
  name: string;
810
839
  /** Slug */
@@ -819,6 +848,13 @@ interface components {
819
848
  sortOrder: number;
820
849
  /** Issystem */
821
850
  isSystem: boolean;
851
+ /**
852
+ * Schemajson
853
+ * @description Entry type schema definition (EntryTypeSchemaDefinition)
854
+ */
855
+ schemaJson?: {
856
+ [key: string]: unknown;
857
+ } | null;
822
858
  /** Createdat */
823
859
  createdAt?: string | null;
824
860
  /** Updateat */
@@ -843,10 +879,20 @@ interface components {
843
879
  sortOrder?: number | null;
844
880
  /** Issystem */
845
881
  isSystem?: boolean | null;
882
+ /**
883
+ * Schema Json
884
+ * @description Entry type schema definition (EntryTypeSchemaDefinition)
885
+ */
886
+ schema_json?: {
887
+ [key: string]: unknown;
888
+ } | null;
846
889
  };
847
890
  /**
848
891
  * EntryUpdate
849
892
  * @description Schema for patching an entry.
893
+ *
894
+ * BREAKING CHANGE: content_markdown removed, replaced with data_json.
895
+ * Entry content is now schema-driven based on entry_type.schema_json.
850
896
  */
851
897
  EntryUpdate: {
852
898
  /** Entry Type Id */
@@ -859,18 +905,26 @@ interface components {
859
905
  summary?: string | null;
860
906
  /** Description */
861
907
  description?: string | null;
862
- /** Content Markdown */
863
- content_markdown?: string | null;
908
+ /**
909
+ * Datajson
910
+ * @description Schema-driven content data (validated against entry_type.schema_json)
911
+ */
912
+ dataJson?: {
913
+ [key: string]: unknown;
914
+ } | null;
864
915
  /** Status */
865
916
  status?: string | null;
866
- /** Published At */
867
- published_at?: string | null;
868
- /** Publish At */
869
- publish_at?: string | null;
870
- /** Expire At */
871
- expire_at?: string | null;
872
- /** Metadata Json */
873
- metadata_json?: {
917
+ /** Publishedat */
918
+ publishedAt?: string | null;
919
+ /** Publishat */
920
+ publishAt?: string | null;
921
+ /** Expireat */
922
+ expireAt?: string | null;
923
+ /**
924
+ * Metadatajson
925
+ * @description Custom non-schema metadata (API keys, external IDs, etc.)
926
+ */
927
+ metadataJson?: {
874
928
  [key: string]: unknown;
875
929
  } | null;
876
930
  /** Collection Ids */
@@ -1630,15 +1684,10 @@ interface components {
1630
1684
  description?: string | null;
1631
1685
  /** Publicurl */
1632
1686
  publicUrl: string;
1633
- /** Metadata */
1634
- metadata?: {
1687
+ /** Metadatajson */
1688
+ metadataJson?: {
1635
1689
  [key: string]: unknown;
1636
1690
  } | null;
1637
- /**
1638
- * Entries
1639
- * @default []
1640
- */
1641
- entries: string[];
1642
1691
  };
1643
1692
  /**
1644
1693
  * PublishedAssetsResponse
@@ -1671,8 +1720,8 @@ interface components {
1671
1720
  smartRules?: {
1672
1721
  [key: string]: unknown;
1673
1722
  } | null;
1674
- /** Metadata */
1675
- metadata?: {
1723
+ /** Metadatajson */
1724
+ metadataJson?: {
1676
1725
  [key: string]: unknown;
1677
1726
  } | null;
1678
1727
  /** Entrycount */
@@ -1683,35 +1732,21 @@ interface components {
1683
1732
  /**
1684
1733
  * PublishedCollectionSummary
1685
1734
  * @description Summary schema for published collections (for listing).
1735
+ *
1736
+ * Minimal collection info for entry contexts - only includes
1737
+ * essential fields for display and ordering.
1686
1738
  */
1687
1739
  PublishedCollectionSummary: {
1688
1740
  /** Slug */
1689
1741
  slug: string;
1690
1742
  /** Name */
1691
1743
  name: string;
1692
- /** Description */
1693
- description?: string | null;
1694
- /**
1695
- * Issmart
1696
- * @default false
1697
- */
1698
- isSmart: boolean;
1699
- /** Smartrules */
1700
- smartRules?: {
1701
- [key: string]: unknown;
1702
- } | null;
1703
- /** Metadata */
1704
- metadata?: {
1744
+ /** Metadatajson */
1745
+ metadataJson?: {
1705
1746
  [key: string]: unknown;
1706
1747
  } | null;
1707
- /** Entrycount */
1708
- entryCount: number;
1709
1748
  /** Sortorder */
1710
1749
  sortOrder: number;
1711
- /** Icon */
1712
- icon?: string | null;
1713
- /** Color */
1714
- color?: string | null;
1715
1750
  };
1716
1751
  /**
1717
1752
  * PublishedCollectionsResponse
@@ -1749,23 +1784,25 @@ interface components {
1749
1784
  summary?: string | null;
1750
1785
  /** Publishedat */
1751
1786
  publishedAt?: string | null;
1787
+ /** Status */
1788
+ status: string;
1752
1789
  /**
1753
1790
  * Collections
1754
1791
  * @default []
1755
1792
  */
1756
1793
  collections: string[];
1757
1794
  /**
1758
- * Assets
1795
+ * Assetslugs
1759
1796
  * @default []
1760
1797
  */
1761
- assets: string[];
1762
- /** Order */
1763
- order?: number | null;
1798
+ assetSlugs: string[];
1764
1799
  /**
1765
- * Resources
1800
+ * Resourceslugs
1766
1801
  * @default []
1767
1802
  */
1768
- resources: string[];
1803
+ resourceSlugs: string[];
1804
+ /** Order */
1805
+ order?: number | null;
1769
1806
  };
1770
1807
  /**
1771
1808
  * PublishedEntryRead
@@ -1773,6 +1810,9 @@ interface components {
1773
1810
  *
1774
1811
  * Only includes public-facing fields. Excludes all admin metadata,
1775
1812
  * internal fields, and user information.
1813
+ *
1814
+ * BREAKING CHANGE: content_markdown removed, replaced with data.
1815
+ * Entry content is now schema-driven based on entry_type.schema_json.
1776
1816
  */
1777
1817
  PublishedEntryRead: {
1778
1818
  /** Slug */
@@ -1783,12 +1823,14 @@ interface components {
1783
1823
  entryType: string;
1784
1824
  /** Summary */
1785
1825
  summary?: string | null;
1786
- /** Contentmarkdown */
1787
- contentMarkdown?: string | null;
1826
+ /** Data */
1827
+ data: {
1828
+ [key: string]: unknown;
1829
+ };
1788
1830
  /** Publishedat */
1789
1831
  publishedAt?: string | null;
1790
- /** Metadata */
1791
- metadata?: {
1832
+ /** Metadatajson */
1833
+ metadataJson?: {
1792
1834
  [key: string]: unknown;
1793
1835
  } | null;
1794
1836
  /**
@@ -1828,8 +1870,8 @@ interface components {
1828
1870
  url?: string | null;
1829
1871
  /** Externalid */
1830
1872
  externalId?: string | null;
1831
- /** Metadata */
1832
- metadata?: {
1873
+ /** Metadatajson */
1874
+ metadataJson?: {
1833
1875
  [key: string]: unknown;
1834
1876
  } | null;
1835
1877
  /** Role */
@@ -1864,8 +1906,8 @@ interface components {
1864
1906
  url?: string | null;
1865
1907
  /** Externalid */
1866
1908
  externalId?: string | null;
1867
- /** Metadata */
1868
- metadata?: {
1909
+ /** Metadatajson */
1910
+ metadataJson?: {
1869
1911
  [key: string]: unknown;
1870
1912
  } | null;
1871
1913
  /**
@@ -2191,8 +2233,8 @@ interface components {
2191
2233
  social?: {
2192
2234
  [key: string]: unknown;
2193
2235
  } | null;
2194
- /** Metadata */
2195
- metadata?: {
2236
+ /** Metadatajson */
2237
+ metadataJson?: {
2196
2238
  [key: string]: unknown;
2197
2239
  } | null;
2198
2240
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@inneropen/marvin-sdk",
3
- "version": "2.0.0-next.3",
3
+ "version": "2.0.0-next.5",
4
4
  "description": "Official TypeScript SDK for Marvin CMS",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",