@inneropen/marvin-sdk 3.1.0 → 3.2.0-next.10

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.
@@ -239,6 +239,22 @@ interface components {
239
239
  /** Darkerror */
240
240
  darkError: string;
241
241
  };
242
+ /** AssetAttachment */
243
+ AssetAttachment: {
244
+ /**
245
+ * Asset Id
246
+ * Format: uuid4
247
+ */
248
+ asset_id: string;
249
+ /** Role */
250
+ role?: string | null;
251
+ /** Position */
252
+ position?: number | null;
253
+ /** Metadata */
254
+ metadata?: {
255
+ [key: string]: unknown;
256
+ } | null;
257
+ };
242
258
  /**
243
259
  * AssetRead
244
260
  * @description Full schema for reading an asset.
@@ -286,8 +302,8 @@ interface components {
286
302
  publicUrl?: string | null;
287
303
  /** Description */
288
304
  description?: string | null;
289
- /** Metadata */
290
- metadata_?: {
305
+ /** Metadatajson */
306
+ metadataJson?: {
291
307
  [key: string]: unknown;
292
308
  } | null;
293
309
  /**
@@ -391,6 +407,20 @@ interface components {
391
407
  /** Isuptodate */
392
408
  isUpToDate: boolean;
393
409
  };
410
+ /** CollectionAttachment */
411
+ CollectionAttachment: {
412
+ /**
413
+ * Collection Id
414
+ * Format: uuid4
415
+ */
416
+ collection_id: string;
417
+ /** Role */
418
+ role?: string | null;
419
+ /** Metadata */
420
+ metadata?: {
421
+ [key: string]: unknown;
422
+ } | null;
423
+ };
394
424
  /**
395
425
  * CollectionCreate
396
426
  * @description Schema for creating a new collection.
@@ -719,17 +749,11 @@ interface components {
719
749
  EntryAssetRead: {
720
750
  /** Role */
721
751
  role?: string | null;
722
- /** Usage */
723
- usage?: string | null;
724
752
  /**
725
753
  * Position
726
754
  * @default 0
727
755
  */
728
756
  position: number;
729
- /** Focalpoint */
730
- focalPoint?: string | null;
731
- /** Caption */
732
- caption?: string | null;
733
757
  /** Placementmetadata */
734
758
  placementMetadata?: {
735
759
  [key: string]: unknown;
@@ -776,8 +800,8 @@ interface components {
776
800
  publicUrl?: string | null;
777
801
  /** Description */
778
802
  description?: string | null;
779
- /** Metadata */
780
- metadata_?: {
803
+ /** Metadatajson */
804
+ metadataJson?: {
781
805
  [key: string]: unknown;
782
806
  } | null;
783
807
  /**
@@ -786,6 +810,36 @@ interface components {
786
810
  */
787
811
  uploadedBy: string;
788
812
  };
813
+ /**
814
+ * EntryCollectionRead
815
+ * @description Collection summary with entry-specific placement details.
816
+ */
817
+ EntryCollectionRead: {
818
+ /**
819
+ * Id
820
+ * Format: uuid4
821
+ */
822
+ id: string;
823
+ /** Name */
824
+ name: string;
825
+ /** Slug */
826
+ slug: string;
827
+ /** Icon */
828
+ icon?: string | null;
829
+ /** Color */
830
+ color?: string | null;
831
+ /** Role */
832
+ role?: string | null;
833
+ /** Placementmetadata */
834
+ placementMetadata?: {
835
+ [key: string]: unknown;
836
+ } | null;
837
+ /**
838
+ * Sortorder
839
+ * @default 0
840
+ */
841
+ sortOrder: number;
842
+ };
789
843
  /**
790
844
  * EntryCreate
791
845
  * @description Schema for creating an entry.
@@ -834,10 +888,16 @@ interface components {
834
888
  } | null;
835
889
  /** Collectionids */
836
890
  collectionIds?: string[] | null;
891
+ /** Collectionattachments */
892
+ collectionAttachments?: components["schemas"]["CollectionAttachment"][] | null;
837
893
  /** Assetids */
838
894
  assetIds?: string[] | null;
839
895
  /** Resourceids */
840
896
  resourceIds?: string[] | null;
897
+ /** Assetattachments */
898
+ assetAttachments?: components["schemas"]["AssetAttachment"][] | null;
899
+ /** Resourceattachments */
900
+ resourceAttachments?: components["schemas"]["ResourceAttachment"][] | null;
841
901
  };
842
902
  /**
843
903
  * EntryOrderItem
@@ -915,7 +975,7 @@ interface components {
915
975
  * Resources
916
976
  * @default []
917
977
  */
918
- resources: components["schemas"]["ResourceSummary"][];
978
+ resources: components["schemas"]["EntryResourceRead"][];
919
979
  /**
920
980
  * Assets
921
981
  * @default []
@@ -925,10 +985,44 @@ interface components {
925
985
  * Collections
926
986
  * @default []
927
987
  */
928
- collections: string[];
988
+ collections: components["schemas"]["EntryCollectionRead"][];
929
989
  /** Order */
930
990
  order?: number | null;
931
991
  };
992
+ /**
993
+ * EntryResourceRead
994
+ * @description Resource metadata plus entry-specific placement details.
995
+ */
996
+ EntryResourceRead: {
997
+ /** Role */
998
+ role?: string | null;
999
+ /**
1000
+ * Position
1001
+ * @default 0
1002
+ */
1003
+ position: number;
1004
+ /** Placementmetadata */
1005
+ placementMetadata?: {
1006
+ [key: string]: unknown;
1007
+ } | null;
1008
+ /**
1009
+ * Id
1010
+ * Format: uuid4
1011
+ */
1012
+ id: string;
1013
+ /** Slug */
1014
+ slug: string;
1015
+ /** Name */
1016
+ name: string;
1017
+ /** Resourcetype */
1018
+ resourceType: string;
1019
+ /** Description */
1020
+ description?: string | null;
1021
+ /** Url */
1022
+ url?: string | null;
1023
+ /** Externalid */
1024
+ externalId?: string | null;
1025
+ };
932
1026
  /**
933
1027
  * EntryTypeCapabilities
934
1028
  * @description Capabilities for a published entry type.
@@ -1165,10 +1259,16 @@ interface components {
1165
1259
  } | null;
1166
1260
  /** Collection Ids */
1167
1261
  collection_ids?: string[] | null;
1262
+ /** Collection Attachments */
1263
+ collection_attachments?: components["schemas"]["CollectionAttachment"][] | null;
1168
1264
  /** Asset Ids */
1169
1265
  asset_ids?: string[] | null;
1170
1266
  /** Resource Ids */
1171
1267
  resource_ids?: string[] | null;
1268
+ /** Asset Attachments */
1269
+ asset_attachments?: components["schemas"]["AssetAttachment"][] | null;
1270
+ /** Resource Attachments */
1271
+ resource_attachments?: components["schemas"]["ResourceAttachment"][] | null;
1172
1272
  };
1173
1273
  /**
1174
1274
  * EventDocumentType
@@ -1873,6 +1973,32 @@ interface components {
1873
1973
  /** Createdat */
1874
1974
  createdAt?: string | null;
1875
1975
  };
1976
+ /**
1977
+ * LoginInfo
1978
+ * @description Public login page configuration — no auth required.
1979
+ */
1980
+ LoginInfo: {
1981
+ /**
1982
+ * Oidcenabled
1983
+ * @default false
1984
+ */
1985
+ oidcEnabled: boolean;
1986
+ /**
1987
+ * Oidcprovidername
1988
+ * @default OAuth
1989
+ */
1990
+ oidcProviderName: string;
1991
+ /**
1992
+ * Oidcautoredirect
1993
+ * @default false
1994
+ */
1995
+ oidcAutoRedirect: boolean;
1996
+ /**
1997
+ * Allowsignup
1998
+ * @default false
1999
+ */
2000
+ allowSignup: boolean;
2001
+ };
1876
2002
  /**
1877
2003
  * LongLiveTokenCreate
1878
2004
  * @description Schema for creating a new long-lived API token (Personal Access Token).
@@ -2051,50 +2177,6 @@ interface components {
2051
2177
  * @enum {string}
2052
2178
  */
2053
2179
  PlatformRole: "NONE" | "SUPER_ADMIN";
2054
- /**
2055
- * PublishedEntryAsset
2056
- * @description An asset as used by a specific entry — relationship context + asset data.
2057
- */
2058
- PublishedEntryAsset: {
2059
- /** Role */
2060
- role?: string | null;
2061
- /**
2062
- * Position
2063
- * @default 0
2064
- */
2065
- position: number;
2066
- /** Focalpoint */
2067
- focalPoint?: string | null;
2068
- /** Caption */
2069
- caption?: string | null;
2070
- /** Metadatajson */
2071
- metadataJson?: {
2072
- [key: string]: unknown;
2073
- } | null;
2074
- asset: components["schemas"]["PublishedAssetRead"];
2075
- };
2076
- /**
2077
- * PublishedEntryResource
2078
- * @description A resource as used by a specific entry — relationship context + resource data.
2079
- */
2080
- PublishedEntryResource: {
2081
- /** Role */
2082
- role?: string | null;
2083
- /** Quantity */
2084
- quantity?: string | null;
2085
- /** Unit */
2086
- unit?: string | null;
2087
- /**
2088
- * Position
2089
- * @default 0
2090
- */
2091
- position: number;
2092
- /** Metadatajson */
2093
- metadataJson?: {
2094
- [key: string]: unknown;
2095
- } | null;
2096
- resource: components["schemas"]["PublishedResourceSummary"];
2097
- };
2098
2180
  /**
2099
2181
  * PublishedAssetRead
2100
2182
  * @description Schema for published assets in the publishing API.
@@ -2180,6 +2262,8 @@ interface components {
2180
2262
  slug: string;
2181
2263
  /** Name */
2182
2264
  name: string;
2265
+ /** Description */
2266
+ description?: string | null;
2183
2267
  /** Metadatajson */
2184
2268
  metadataJson?: {
2185
2269
  [key: string]: unknown;
@@ -2205,6 +2289,42 @@ interface components {
2205
2289
  data: components["schemas"]["PublishedEntryListItem"][];
2206
2290
  meta: components["schemas"]["PaginationMeta"];
2207
2291
  };
2292
+ /**
2293
+ * PublishedEntryAsset
2294
+ * @description An asset as used by a specific entry — relationship context + asset data.
2295
+ */
2296
+ PublishedEntryAsset: {
2297
+ /** Role */
2298
+ role?: string | null;
2299
+ /**
2300
+ * Position
2301
+ * @default 0
2302
+ */
2303
+ position: number;
2304
+ /** Metadatajson */
2305
+ metadataJson?: {
2306
+ [key: string]: unknown;
2307
+ } | null;
2308
+ asset: components["schemas"]["PublishedAssetRead"];
2309
+ };
2310
+ /**
2311
+ * PublishedEntryCollection
2312
+ * @description A collection as used by a specific entry — relationship context + collection data.
2313
+ */
2314
+ PublishedEntryCollection: {
2315
+ /** Role */
2316
+ role?: string | null;
2317
+ /**
2318
+ * Position
2319
+ * @default 0
2320
+ */
2321
+ position: number;
2322
+ /** Metadatajson */
2323
+ metadataJson?: {
2324
+ [key: string]: unknown;
2325
+ } | null;
2326
+ collection: components["schemas"]["PublishedCollectionSummary"];
2327
+ };
2208
2328
  /**
2209
2329
  * PublishedEntryListItem
2210
2330
  * @description Minimal entry schema for list responses.
@@ -2230,7 +2350,7 @@ interface components {
2230
2350
  * Collections
2231
2351
  * @default []
2232
2352
  */
2233
- collections: string[];
2353
+ collections: components["schemas"]["PublishedEntryCollection"][];
2234
2354
  /**
2235
2355
  * Assetslugs
2236
2356
  * @default []
@@ -2283,7 +2403,7 @@ interface components {
2283
2403
  * Collections
2284
2404
  * @default []
2285
2405
  */
2286
- collections: components["schemas"]["PublishedCollectionSummary"][];
2406
+ collections: components["schemas"]["PublishedEntryCollection"][];
2287
2407
  /**
2288
2408
  * Resources
2289
2409
  * @default []
@@ -2297,6 +2417,24 @@ interface components {
2297
2417
  /** Order */
2298
2418
  order?: number | null;
2299
2419
  };
2420
+ /**
2421
+ * PublishedEntryResource
2422
+ * @description A resource as used by a specific entry — relationship context + resource data.
2423
+ */
2424
+ PublishedEntryResource: {
2425
+ /** Role */
2426
+ role?: string | null;
2427
+ /**
2428
+ * Position
2429
+ * @default 0
2430
+ */
2431
+ position: number;
2432
+ /** Metadatajson */
2433
+ metadataJson?: {
2434
+ [key: string]: unknown;
2435
+ } | null;
2436
+ resource: components["schemas"]["PublishedResourceSummary"];
2437
+ };
2300
2438
  /**
2301
2439
  * PublishedEntryTypeInfo
2302
2440
  * @description Flattened entry type rendering and capabilities info for published entries.
@@ -2434,6 +2572,22 @@ interface components {
2434
2572
  /** Passwordconfirm */
2435
2573
  passwordConfirm: string;
2436
2574
  };
2575
+ /** ResourceAttachment */
2576
+ ResourceAttachment: {
2577
+ /**
2578
+ * Resource Id
2579
+ * Format: uuid4
2580
+ */
2581
+ resource_id: string;
2582
+ /** Role */
2583
+ role?: string | null;
2584
+ /** Position */
2585
+ position?: number | null;
2586
+ /** Metadata */
2587
+ metadata?: {
2588
+ [key: string]: unknown;
2589
+ } | null;
2590
+ };
2437
2591
  /**
2438
2592
  * ResourceCreate
2439
2593
  * @description Schema for creating a new resource.
@@ -2478,8 +2632,8 @@ interface components {
2478
2632
  url?: string | null;
2479
2633
  /** Externalid */
2480
2634
  externalId?: string | null;
2481
- /** Metadata */
2482
- metadata?: {
2635
+ /** Metadatajson */
2636
+ metadataJson?: {
2483
2637
  [key: string]: unknown;
2484
2638
  } | null;
2485
2639
  /**
@@ -2488,29 +2642,6 @@ interface components {
2488
2642
  */
2489
2643
  createdBy: string;
2490
2644
  };
2491
- /**
2492
- * ResourceSummary
2493
- * @description Summary schema for a resource.
2494
- */
2495
- ResourceSummary: {
2496
- /**
2497
- * Id
2498
- * Format: uuid4
2499
- */
2500
- id: string;
2501
- /** Slug */
2502
- slug: string;
2503
- /** Name */
2504
- name: string;
2505
- /** Resourcetype */
2506
- resourceType: string;
2507
- /** Description */
2508
- description?: string | null;
2509
- /** Url */
2510
- url?: string | null;
2511
- /** Externalid */
2512
- externalId?: string | null;
2513
- };
2514
2645
  /**
2515
2646
  * ResourceUpdate
2516
2647
  * @description Schema for updating a resource.
@@ -2802,6 +2933,18 @@ interface components {
2802
2933
  */
2803
2934
  unlocked: number;
2804
2935
  };
2936
+ /**
2937
+ * UpdateEntryCollectionRequest
2938
+ * @description Schema for updating junction fields on an entry-collection relationship.
2939
+ */
2940
+ UpdateEntryCollectionRequest: {
2941
+ /** Role */
2942
+ role?: string | null;
2943
+ /** Metadatajson */
2944
+ metadataJson?: {
2945
+ [key: string]: unknown;
2946
+ } | null;
2947
+ };
2805
2948
  /**
2806
2949
  * UserCreate
2807
2950
  * @description Schema for creating a new user.
@@ -3358,12 +3501,74 @@ type MarvinEntryListItem = components['schemas']['PublishedEntryListItem'];
3358
3501
  type PublishedEntryType = components['schemas']['PublishedEntryTypeRead'];
3359
3502
  type MarvinCollection = components['schemas']['PublishedCollectionRead'];
3360
3503
  type PublishedCollectionSummary = components['schemas']['PublishedCollectionSummary'];
3504
+ type PublishedEntryCollection = components['schemas']['PublishedEntryCollection'];
3361
3505
  type MarvinAsset = components['schemas']['PublishedAssetRead'];
3362
3506
  type PublishedAssetRead = components['schemas']['PublishedAssetRead'];
3363
3507
  type PublishedEntryAsset = components['schemas']['PublishedEntryAsset'];
3364
3508
  type MarvinResource = components['schemas']['PublishedResourceSummary'];
3509
+ type PublishedResourceSummary = components['schemas']['PublishedResourceSummary'];
3365
3510
  type PublishedEntryResource = components['schemas']['PublishedEntryResource'];
3511
+ type AssetAttachment = components['schemas']['AssetAttachment'];
3512
+ type CollectionAttachment = components['schemas']['CollectionAttachment'];
3513
+ type ResourceAttachment = components['schemas']['ResourceAttachment'];
3514
+ type EntryCollectionRead = components['schemas']['EntryCollectionRead'];
3366
3515
  type MarvinEntryType = components['schemas']['EntryTypeRead'];
3516
+ /** Entry-specific relationship data within a collection */
3517
+ interface CollectionEntryMetadata {
3518
+ role: string | null;
3519
+ position: number;
3520
+ metadataJson: Record<string, unknown> | null;
3521
+ }
3522
+ /** The collection context when an entry is fetched through a specific collection */
3523
+ interface CollectionContext {
3524
+ slug: string;
3525
+ name: string;
3526
+ description?: string | null;
3527
+ metadataJson?: Record<string, unknown> | null;
3528
+ /** This entry's relationship to the collection (role, position, junction metadata) */
3529
+ entryMetadata: CollectionEntryMetadata;
3530
+ }
3531
+ /**
3532
+ * An entry as returned when fetched through a specific collection.
3533
+ * - `collection`: the collection you queried through, with its junction context
3534
+ * - `collectionSlugs`: slugs of other collections this entry also belongs to
3535
+ */
3536
+ interface CollectionEntry extends Omit<MarvinEntryListItem, 'collections'> {
3537
+ collection: CollectionContext;
3538
+ /** All collection slugs this entry belongs to, including the one queried through */
3539
+ collectionSlugs: string[];
3540
+ }
3541
+ /**
3542
+ * A collection membership as it appears on an entry.
3543
+ * - `collection`: the collection's own fields (slug, name, description, metadataJson, sortOrder)
3544
+ * - `entryMetadata`: the entry's relationship to this collection (role, position, metadataJson)
3545
+ */
3546
+ interface EntryCollectionContext {
3547
+ collection: PublishedCollectionSummary;
3548
+ entryMetadata: CollectionEntryMetadata;
3549
+ }
3550
+ /**
3551
+ * An entry as returned from the general entries list.
3552
+ * Same as MarvinEntryListItem but with collections transformed to EntryCollectionContext[]
3553
+ * so the entryMetadata naming convention is consistent across all entry contexts.
3554
+ */
3555
+ interface ListEntry extends Omit<MarvinEntryListItem, 'collections'> {
3556
+ collections: EntryCollectionContext[];
3557
+ }
3558
+ /**
3559
+ * An asset as it appears on an entry — includes the asset's own fields
3560
+ * plus `entryMetadata` for the entry's relationship to this asset.
3561
+ */
3562
+ interface EntryAsset extends PublishedAssetRead {
3563
+ entryMetadata: CollectionEntryMetadata;
3564
+ }
3565
+ /**
3566
+ * A resource as it appears on an entry — includes the resource's own fields
3567
+ * plus `entryMetadata` for the entry's relationship to this resource.
3568
+ */
3569
+ interface EntryResource extends PublishedResourceSummary {
3570
+ entryMetadata: CollectionEntryMetadata;
3571
+ }
3367
3572
  interface AssetUploadRequest {
3368
3573
  slug: string;
3369
3574
  name: string;
@@ -3406,4 +3611,4 @@ interface AuthToken {
3406
3611
  tokenType: string;
3407
3612
  }
3408
3613
 
3409
- export type { AuthToken as A, GetAssetsOptions as G, MarvinAsset as M, PublishedAssetRead as P, SiteConfiguration as S, WorkspaceInfo as W, GetEntriesOptions as a, GetResourcesOptions as b, MarvinCollection as c, MarvinEntry as d, MarvinEntryListItem as e, MarvinEntryType as f, MarvinPublishResponse as g, MarvinResource as h, MarvinSite as i, PublishedCollectionSummary as j, PublishedEntryAsset as k, PublishedEntryResource as l, PublishedEntryType as m, components as n, AssetUploadRequest as o, MarvinClientConfig as p };
3614
+ export type { AuthToken as A, CollectionContext as C, EntryAsset as E, GetAssetsOptions as G, ListEntry as L, MarvinAsset as M, PublishedAssetRead as P, ResourceAttachment as R, SiteConfiguration as S, WorkspaceInfo as W, CollectionEntry as a, CollectionEntryMetadata as b, EntryCollectionContext as c, EntryResource as d, GetEntriesOptions as e, GetResourcesOptions as f, MarvinCollection as g, MarvinEntry as h, MarvinEntryListItem as i, MarvinEntryType as j, MarvinPublishResponse as k, MarvinResource as l, MarvinSite as m, PublishedCollectionSummary as n, PublishedEntryAsset as o, PublishedEntryResource as p, PublishedEntryType as q, components as r, AssetAttachment as s, AssetUploadRequest as t, CollectionAttachment as u, EntryCollectionRead as v, MarvinClientConfig as w, PublishedEntryCollection as x, PublishedResourceSummary as y };