@ndla/types-backend 1.0.129 → 1.0.131

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.
@@ -372,6 +372,46 @@ export type paths = {
372
372
  patch?: never;
373
373
  trace?: never;
374
374
  };
375
+ "/image-api/v1/bulk": {
376
+ parameters: {
377
+ query?: never;
378
+ header?: never;
379
+ path?: never;
380
+ cookie?: never;
381
+ };
382
+ get?: never;
383
+ put?: never;
384
+ /**
385
+ * Start a bulk image upload session
386
+ * @description Stages all uploaded images and starts an asynchronous bulk upload.
387
+ */
388
+ post: operations["postImage-apiV1Bulk"];
389
+ delete?: never;
390
+ options?: never;
391
+ head?: never;
392
+ patch?: never;
393
+ trace?: never;
394
+ };
395
+ "/image-api/v1/bulk/status/{upload-id}": {
396
+ parameters: {
397
+ query?: never;
398
+ header?: never;
399
+ path?: never;
400
+ cookie?: never;
401
+ };
402
+ /**
403
+ * Stream the status of a bulk upload session
404
+ * @description Returns Server-Sent Events with progress updates for the given upload-id.
405
+ */
406
+ get: operations["getImage-apiV1BulkStatusUpload-id"];
407
+ put?: never;
408
+ post?: never;
409
+ delete?: never;
410
+ options?: never;
411
+ head?: never;
412
+ patch?: never;
413
+ trace?: never;
414
+ };
375
415
  };
376
416
  export type webhooks = Record<string, never>;
377
417
  export type components = {
@@ -387,6 +427,51 @@ export type components = {
387
427
  /** @description The name of the of the author */
388
428
  name: string;
389
429
  };
430
+ /** BatchMetaDataAndFileForm */
431
+ BatchMetaDataAndFileForm: {
432
+ metadatas: components["schemas"]["NewImageMetaInformationV2DTO"][];
433
+ files: Blob[];
434
+ };
435
+ /** BulkUploadItemDTO */
436
+ BulkUploadItemDTO: {
437
+ fileName?: string;
438
+ status: components["schemas"]["BulkUploadItemStatus"];
439
+ image?: components["schemas"]["ImageMetaInformationV3DTO"];
440
+ error?: string;
441
+ };
442
+ /**
443
+ * BulkUploadItemStatus
444
+ * @enum {string}
445
+ */
446
+ BulkUploadItemStatus: "Done" | "Failed" | "Pending" | "Uploading";
447
+ /**
448
+ * BulkUploadStartedDTO
449
+ * @description Identifier returned when a bulk upload session has been started
450
+ */
451
+ BulkUploadStartedDTO: {
452
+ /**
453
+ * Format: uuid
454
+ * @description Identifier used to track the bulk upload via the status endpoint
455
+ */
456
+ uploadId: string;
457
+ };
458
+ /** BulkUploadStateDTO */
459
+ BulkUploadStateDTO: {
460
+ status: components["schemas"]["BulkUploadStatus"];
461
+ /** Format: int32 */
462
+ total: number;
463
+ /** Format: int32 */
464
+ completed: number;
465
+ /** Format: int32 */
466
+ failed: number;
467
+ items: components["schemas"]["BulkUploadItemDTO"][];
468
+ error?: string;
469
+ };
470
+ /**
471
+ * BulkUploadStatus
472
+ * @enum {string}
473
+ */
474
+ BulkUploadStatus: "Complete" | "Failed" | "Pending" | "Running";
390
475
  /**
391
476
  * ContributorType
392
477
  * @description The description of the author. Eg. Photographer or Supplier
@@ -914,6 +999,12 @@ export type components = {
914
999
  };
915
1000
  export type AllErrors = components['schemas']['AllErrors'];
916
1001
  export type AuthorDTO = components['schemas']['AuthorDTO'];
1002
+ export type BatchMetaDataAndFileForm = components['schemas']['BatchMetaDataAndFileForm'];
1003
+ export type BulkUploadItemDTO = components['schemas']['BulkUploadItemDTO'];
1004
+ export type BulkUploadItemStatus = components['schemas']['BulkUploadItemStatus'];
1005
+ export type BulkUploadStartedDTO = components['schemas']['BulkUploadStartedDTO'];
1006
+ export type BulkUploadStateDTO = components['schemas']['BulkUploadStateDTO'];
1007
+ export type BulkUploadStatus = components['schemas']['BulkUploadStatus'];
917
1008
  export type ContributorType = components['schemas']['ContributorType'];
918
1009
  export type CopyMetaDataAndFileForm = components['schemas']['CopyMetaDataAndFileForm'];
919
1010
  export type CopyrightDTO = components['schemas']['CopyrightDTO'];
@@ -2426,4 +2517,136 @@ export interface operations {
2426
2517
  };
2427
2518
  };
2428
2519
  };
2520
+ "postImage-apiV1Bulk": {
2521
+ parameters: {
2522
+ query?: never;
2523
+ header?: never;
2524
+ path?: never;
2525
+ cookie?: never;
2526
+ };
2527
+ requestBody: {
2528
+ content: {
2529
+ "multipart/form-data": components["schemas"]["BatchMetaDataAndFileForm"];
2530
+ };
2531
+ };
2532
+ responses: {
2533
+ 200: {
2534
+ headers: {
2535
+ [name: string]: unknown;
2536
+ };
2537
+ content: {
2538
+ "application/json": components["schemas"]["BulkUploadStartedDTO"];
2539
+ };
2540
+ };
2541
+ 400: {
2542
+ headers: {
2543
+ [name: string]: unknown;
2544
+ };
2545
+ content: {
2546
+ "application/json": components["schemas"]["AllErrors"];
2547
+ };
2548
+ };
2549
+ 401: {
2550
+ headers: {
2551
+ [name: string]: unknown;
2552
+ };
2553
+ content: {
2554
+ "application/json": components["schemas"]["AllErrors"];
2555
+ };
2556
+ };
2557
+ 403: {
2558
+ headers: {
2559
+ [name: string]: unknown;
2560
+ };
2561
+ content: {
2562
+ "application/json": components["schemas"]["AllErrors"];
2563
+ };
2564
+ };
2565
+ 404: {
2566
+ headers: {
2567
+ [name: string]: unknown;
2568
+ };
2569
+ content: {
2570
+ "application/json": components["schemas"]["AllErrors"];
2571
+ };
2572
+ };
2573
+ default: {
2574
+ headers: {
2575
+ [name: string]: unknown;
2576
+ };
2577
+ content: {
2578
+ "application/json": components["schemas"]["AllErrors"];
2579
+ };
2580
+ };
2581
+ };
2582
+ };
2583
+ "getImage-apiV1BulkStatusUpload-id": {
2584
+ parameters: {
2585
+ query?: never;
2586
+ header?: never;
2587
+ path: {
2588
+ "upload-id": string;
2589
+ };
2590
+ cookie?: never;
2591
+ };
2592
+ requestBody?: never;
2593
+ responses: {
2594
+ 200: {
2595
+ headers: {
2596
+ [name: string]: unknown;
2597
+ };
2598
+ content: {
2599
+ "text/event-stream": components["schemas"]["BulkUploadStateDTO"];
2600
+ };
2601
+ };
2602
+ 400: {
2603
+ headers: {
2604
+ [name: string]: unknown;
2605
+ };
2606
+ content: {
2607
+ "application/json": components["schemas"]["AllErrors"];
2608
+ };
2609
+ };
2610
+ 401: {
2611
+ headers: {
2612
+ [name: string]: unknown;
2613
+ };
2614
+ content: {
2615
+ "application/json": components["schemas"]["AllErrors"];
2616
+ };
2617
+ };
2618
+ 403: {
2619
+ headers: {
2620
+ [name: string]: unknown;
2621
+ };
2622
+ content: {
2623
+ "application/json": components["schemas"]["AllErrors"];
2624
+ };
2625
+ };
2626
+ 404: {
2627
+ headers: {
2628
+ [name: string]: unknown;
2629
+ };
2630
+ content: {
2631
+ "application/json": components["schemas"]["AllErrors"];
2632
+ };
2633
+ };
2634
+ 500: {
2635
+ headers: {
2636
+ [name: string]: unknown;
2637
+ };
2638
+ content: {
2639
+ "application/json": components["schemas"]["AllErrors"];
2640
+ };
2641
+ };
2642
+ default: {
2643
+ headers: {
2644
+ [name: string]: unknown;
2645
+ };
2646
+ content: {
2647
+ "application/json": components["schemas"]["AllErrors"];
2648
+ };
2649
+ };
2650
+ };
2651
+ };
2429
2652
  }
package/package.json CHANGED
@@ -33,6 +33,6 @@
33
33
  "tsx": "^4.21.0",
34
34
  "typescript": "^5.9.3"
35
35
  },
36
- "version": "1.0.129",
36
+ "version": "1.0.131",
37
37
  "packageManager": "yarn@4.10.3"
38
38
  }