@dazl/internal-api-client 1.10.0 → 1.11.0

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.
@@ -101,6 +101,37 @@ export type ProjectRaw = {
101
101
  export type OwnerDazlId = {
102
102
  ownerDazlId: string;
103
103
  };
104
+ export type UserMention = {
105
+ dazlUserId: string;
106
+ };
107
+ export type CommentResolved = {
108
+ dazlUserId: string;
109
+ resolvedAt: string;
110
+ };
111
+ export type CommentContext = {
112
+ type: 'stage';
113
+ page: string;
114
+ selection?: string;
115
+ };
116
+ export type InternalCreateCommentInput = {
117
+ content: string;
118
+ authorDazlUserId: string;
119
+ mentions?: Array<UserMention>;
120
+ context?: CommentContext;
121
+ };
122
+ export type InternalEditCommentInput = {
123
+ content: string;
124
+ mentions?: Array<UserMention>;
125
+ };
126
+ export type InternalCreateReplyInput = {
127
+ content: string;
128
+ mentions?: Array<UserMention>;
129
+ authorDazlUserId: string;
130
+ };
131
+ export type InternalEditReplyInput = {
132
+ content: string;
133
+ mentions?: Array<UserMention>;
134
+ };
104
135
  export type TemplateRaw = {
105
136
  id: string;
106
137
  name: string;
@@ -2397,6 +2428,617 @@ export type DeleteProjectInvitationResponses = {
2397
2428
  };
2398
2429
  };
2399
2430
  export type DeleteProjectInvitationResponse = DeleteProjectInvitationResponses[keyof DeleteProjectInvitationResponses];
2431
+ export type InternalListProjectCommentsData = {
2432
+ body?: never;
2433
+ path: {
2434
+ projectId: string;
2435
+ };
2436
+ query?: never;
2437
+ url: '/project/{projectId}/comments';
2438
+ };
2439
+ export type InternalListProjectCommentsErrors = {
2440
+ /**
2441
+ * Bad request - Invalid parameters or malformed JSON
2442
+ */
2443
+ 400: {
2444
+ message: string;
2445
+ issues?: string;
2446
+ };
2447
+ /**
2448
+ * Unauthorized
2449
+ */
2450
+ 401: ErrorResponse;
2451
+ /**
2452
+ * Forbidden
2453
+ */
2454
+ 403: ErrorResponse;
2455
+ /**
2456
+ * Not Found
2457
+ */
2458
+ 404: ErrorResponse;
2459
+ /**
2460
+ * Conflict
2461
+ */
2462
+ 409: ErrorResponse;
2463
+ /**
2464
+ * Internal server error
2465
+ */
2466
+ 500: ErrorResponse;
2467
+ /**
2468
+ * Service Unavailable
2469
+ */
2470
+ 503: ErrorResponse;
2471
+ };
2472
+ export type InternalListProjectCommentsError = InternalListProjectCommentsErrors[keyof InternalListProjectCommentsErrors];
2473
+ export type InternalListProjectCommentsResponses = {
2474
+ /**
2475
+ * Returns the list of comments for the project
2476
+ */
2477
+ 200: {
2478
+ comments: Array<{
2479
+ commentId: string;
2480
+ author: {
2481
+ dazlUserId: string;
2482
+ };
2483
+ content: string;
2484
+ mentions: Array<UserMention>;
2485
+ createdAt: string;
2486
+ updatedAt: string;
2487
+ lastActivityAt: string;
2488
+ isEdited: boolean;
2489
+ replies: Array<{
2490
+ replyId: string;
2491
+ author: {
2492
+ dazlUserId: string;
2493
+ };
2494
+ content: string;
2495
+ mentions: Array<UserMention>;
2496
+ createdAt: string;
2497
+ updatedAt: string;
2498
+ }>;
2499
+ resolved?: CommentResolved;
2500
+ context?: CommentContext;
2501
+ }>;
2502
+ /**
2503
+ * Authors and mentions from loaded comments with id, email and picture to render avatars
2504
+ */
2505
+ participants: Array<{
2506
+ userId: string;
2507
+ email: string;
2508
+ picture?: string;
2509
+ }>;
2510
+ };
2511
+ };
2512
+ export type InternalListProjectCommentsResponse = InternalListProjectCommentsResponses[keyof InternalListProjectCommentsResponses];
2513
+ export type InternalCreateCommentData = {
2514
+ body: InternalCreateCommentInput;
2515
+ path: {
2516
+ projectId: string;
2517
+ };
2518
+ query?: never;
2519
+ url: '/project/{projectId}/comments';
2520
+ };
2521
+ export type InternalCreateCommentErrors = {
2522
+ /**
2523
+ * Bad request - Invalid parameters or malformed JSON
2524
+ */
2525
+ 400: {
2526
+ message: string;
2527
+ issues?: string;
2528
+ };
2529
+ /**
2530
+ * Unauthorized
2531
+ */
2532
+ 401: ErrorResponse;
2533
+ /**
2534
+ * Forbidden
2535
+ */
2536
+ 403: ErrorResponse;
2537
+ /**
2538
+ * Not Found
2539
+ */
2540
+ 404: ErrorResponse;
2541
+ /**
2542
+ * Conflict
2543
+ */
2544
+ 409: ErrorResponse;
2545
+ /**
2546
+ * Internal server error
2547
+ */
2548
+ 500: ErrorResponse;
2549
+ /**
2550
+ * Service Unavailable
2551
+ */
2552
+ 503: ErrorResponse;
2553
+ };
2554
+ export type InternalCreateCommentError = InternalCreateCommentErrors[keyof InternalCreateCommentErrors];
2555
+ export type InternalCreateCommentResponses = {
2556
+ /**
2557
+ * Returns the created comment
2558
+ */
2559
+ 200: {
2560
+ comment: {
2561
+ commentId: string;
2562
+ author: {
2563
+ dazlUserId: string;
2564
+ };
2565
+ content: string;
2566
+ mentions: Array<UserMention>;
2567
+ createdAt: string;
2568
+ updatedAt: string;
2569
+ lastActivityAt: string;
2570
+ isEdited: boolean;
2571
+ replies: Array<{
2572
+ replyId: string;
2573
+ author: {
2574
+ dazlUserId: string;
2575
+ };
2576
+ content: string;
2577
+ mentions: Array<UserMention>;
2578
+ createdAt: string;
2579
+ updatedAt: string;
2580
+ }>;
2581
+ resolved?: CommentResolved;
2582
+ context?: CommentContext;
2583
+ };
2584
+ };
2585
+ };
2586
+ export type InternalCreateCommentResponse = InternalCreateCommentResponses[keyof InternalCreateCommentResponses];
2587
+ export type InternalDeleteCommentData = {
2588
+ body?: never;
2589
+ path: {
2590
+ projectId: string;
2591
+ commentId: string;
2592
+ };
2593
+ query?: never;
2594
+ url: '/project/{projectId}/comments/{commentId}';
2595
+ };
2596
+ export type InternalDeleteCommentErrors = {
2597
+ /**
2598
+ * Bad request - Invalid parameters or malformed JSON
2599
+ */
2600
+ 400: {
2601
+ message: string;
2602
+ issues?: string;
2603
+ };
2604
+ /**
2605
+ * Unauthorized
2606
+ */
2607
+ 401: ErrorResponse;
2608
+ /**
2609
+ * Forbidden
2610
+ */
2611
+ 403: ErrorResponse;
2612
+ /**
2613
+ * Not Found
2614
+ */
2615
+ 404: ErrorResponse;
2616
+ /**
2617
+ * Conflict
2618
+ */
2619
+ 409: ErrorResponse;
2620
+ /**
2621
+ * Internal server error
2622
+ */
2623
+ 500: ErrorResponse;
2624
+ /**
2625
+ * Service Unavailable
2626
+ */
2627
+ 503: ErrorResponse;
2628
+ };
2629
+ export type InternalDeleteCommentError = InternalDeleteCommentErrors[keyof InternalDeleteCommentErrors];
2630
+ export type InternalDeleteCommentResponses = {
2631
+ /**
2632
+ * Acknowledges that the comment was deleted
2633
+ */
2634
+ 200: {
2635
+ success: true;
2636
+ };
2637
+ };
2638
+ export type InternalDeleteCommentResponse = InternalDeleteCommentResponses[keyof InternalDeleteCommentResponses];
2639
+ export type InternalEditCommentData = {
2640
+ body: InternalEditCommentInput;
2641
+ path: {
2642
+ projectId: string;
2643
+ commentId: string;
2644
+ };
2645
+ query?: never;
2646
+ url: '/project/{projectId}/comments/{commentId}';
2647
+ };
2648
+ export type InternalEditCommentErrors = {
2649
+ /**
2650
+ * Bad request - Invalid parameters or malformed JSON
2651
+ */
2652
+ 400: {
2653
+ message: string;
2654
+ issues?: string;
2655
+ };
2656
+ /**
2657
+ * Unauthorized
2658
+ */
2659
+ 401: ErrorResponse;
2660
+ /**
2661
+ * Forbidden
2662
+ */
2663
+ 403: ErrorResponse;
2664
+ /**
2665
+ * Not Found
2666
+ */
2667
+ 404: ErrorResponse;
2668
+ /**
2669
+ * Conflict
2670
+ */
2671
+ 409: ErrorResponse;
2672
+ /**
2673
+ * Internal server error
2674
+ */
2675
+ 500: ErrorResponse;
2676
+ /**
2677
+ * Service Unavailable
2678
+ */
2679
+ 503: ErrorResponse;
2680
+ };
2681
+ export type InternalEditCommentError = InternalEditCommentErrors[keyof InternalEditCommentErrors];
2682
+ export type InternalEditCommentResponses = {
2683
+ /**
2684
+ * Returns the updated comment
2685
+ */
2686
+ 200: {
2687
+ comment: {
2688
+ commentId: string;
2689
+ author: {
2690
+ dazlUserId: string;
2691
+ };
2692
+ content: string;
2693
+ mentions: Array<UserMention>;
2694
+ createdAt: string;
2695
+ updatedAt: string;
2696
+ lastActivityAt: string;
2697
+ isEdited: boolean;
2698
+ replies: Array<{
2699
+ replyId: string;
2700
+ author: {
2701
+ dazlUserId: string;
2702
+ };
2703
+ content: string;
2704
+ mentions: Array<UserMention>;
2705
+ createdAt: string;
2706
+ updatedAt: string;
2707
+ }>;
2708
+ resolved?: CommentResolved;
2709
+ context?: CommentContext;
2710
+ };
2711
+ };
2712
+ };
2713
+ export type InternalEditCommentResponse = InternalEditCommentResponses[keyof InternalEditCommentResponses];
2714
+ export type InternalResolveCommentData = {
2715
+ body?: never;
2716
+ path: {
2717
+ projectId: string;
2718
+ commentId: string;
2719
+ };
2720
+ query: {
2721
+ resolvedByDazlUserId: string;
2722
+ };
2723
+ url: '/project/{projectId}/comments/{commentId}/resolve';
2724
+ };
2725
+ export type InternalResolveCommentErrors = {
2726
+ /**
2727
+ * Bad request - Invalid parameters or malformed JSON
2728
+ */
2729
+ 400: {
2730
+ message: string;
2731
+ issues?: string;
2732
+ };
2733
+ /**
2734
+ * Unauthorized
2735
+ */
2736
+ 401: ErrorResponse;
2737
+ /**
2738
+ * Forbidden
2739
+ */
2740
+ 403: ErrorResponse;
2741
+ /**
2742
+ * Not Found
2743
+ */
2744
+ 404: ErrorResponse;
2745
+ /**
2746
+ * Conflict
2747
+ */
2748
+ 409: ErrorResponse;
2749
+ /**
2750
+ * Internal server error
2751
+ */
2752
+ 500: ErrorResponse;
2753
+ /**
2754
+ * Service Unavailable
2755
+ */
2756
+ 503: ErrorResponse;
2757
+ };
2758
+ export type InternalResolveCommentError = InternalResolveCommentErrors[keyof InternalResolveCommentErrors];
2759
+ export type InternalResolveCommentResponses = {
2760
+ /**
2761
+ * Returns the resolved comment
2762
+ */
2763
+ 200: {
2764
+ comment: {
2765
+ commentId: string;
2766
+ author: {
2767
+ dazlUserId: string;
2768
+ };
2769
+ content: string;
2770
+ mentions: Array<UserMention>;
2771
+ createdAt: string;
2772
+ updatedAt: string;
2773
+ lastActivityAt: string;
2774
+ isEdited: boolean;
2775
+ replies: Array<{
2776
+ replyId: string;
2777
+ author: {
2778
+ dazlUserId: string;
2779
+ };
2780
+ content: string;
2781
+ mentions: Array<UserMention>;
2782
+ createdAt: string;
2783
+ updatedAt: string;
2784
+ }>;
2785
+ resolved?: CommentResolved;
2786
+ context?: CommentContext;
2787
+ };
2788
+ };
2789
+ };
2790
+ export type InternalResolveCommentResponse = InternalResolveCommentResponses[keyof InternalResolveCommentResponses];
2791
+ export type InternalReopenCommentData = {
2792
+ body?: never;
2793
+ path: {
2794
+ projectId: string;
2795
+ commentId: string;
2796
+ };
2797
+ query?: never;
2798
+ url: '/project/{projectId}/comments/{commentId}/reopen';
2799
+ };
2800
+ export type InternalReopenCommentErrors = {
2801
+ /**
2802
+ * Bad request - Invalid parameters or malformed JSON
2803
+ */
2804
+ 400: {
2805
+ message: string;
2806
+ issues?: string;
2807
+ };
2808
+ /**
2809
+ * Unauthorized
2810
+ */
2811
+ 401: ErrorResponse;
2812
+ /**
2813
+ * Forbidden
2814
+ */
2815
+ 403: ErrorResponse;
2816
+ /**
2817
+ * Not Found
2818
+ */
2819
+ 404: ErrorResponse;
2820
+ /**
2821
+ * Conflict
2822
+ */
2823
+ 409: ErrorResponse;
2824
+ /**
2825
+ * Internal server error
2826
+ */
2827
+ 500: ErrorResponse;
2828
+ /**
2829
+ * Service Unavailable
2830
+ */
2831
+ 503: ErrorResponse;
2832
+ };
2833
+ export type InternalReopenCommentError = InternalReopenCommentErrors[keyof InternalReopenCommentErrors];
2834
+ export type InternalReopenCommentResponses = {
2835
+ /**
2836
+ * Returns the reopened comment
2837
+ */
2838
+ 200: {
2839
+ comment: {
2840
+ commentId: string;
2841
+ author: {
2842
+ dazlUserId: string;
2843
+ };
2844
+ content: string;
2845
+ mentions: Array<UserMention>;
2846
+ createdAt: string;
2847
+ updatedAt: string;
2848
+ lastActivityAt: string;
2849
+ isEdited: boolean;
2850
+ replies: Array<{
2851
+ replyId: string;
2852
+ author: {
2853
+ dazlUserId: string;
2854
+ };
2855
+ content: string;
2856
+ mentions: Array<UserMention>;
2857
+ createdAt: string;
2858
+ updatedAt: string;
2859
+ }>;
2860
+ resolved?: CommentResolved;
2861
+ context?: CommentContext;
2862
+ };
2863
+ };
2864
+ };
2865
+ export type InternalReopenCommentResponse = InternalReopenCommentResponses[keyof InternalReopenCommentResponses];
2866
+ export type InternalCreateReplyData = {
2867
+ body: InternalCreateReplyInput;
2868
+ path: {
2869
+ projectId: string;
2870
+ commentId: string;
2871
+ };
2872
+ query?: never;
2873
+ url: '/project/{projectId}/comments/{commentId}/replies';
2874
+ };
2875
+ export type InternalCreateReplyErrors = {
2876
+ /**
2877
+ * Bad request - Invalid parameters or malformed JSON
2878
+ */
2879
+ 400: {
2880
+ message: string;
2881
+ issues?: string;
2882
+ };
2883
+ /**
2884
+ * Unauthorized
2885
+ */
2886
+ 401: ErrorResponse;
2887
+ /**
2888
+ * Forbidden
2889
+ */
2890
+ 403: ErrorResponse;
2891
+ /**
2892
+ * Not Found
2893
+ */
2894
+ 404: ErrorResponse;
2895
+ /**
2896
+ * Conflict
2897
+ */
2898
+ 409: ErrorResponse;
2899
+ /**
2900
+ * Internal server error
2901
+ */
2902
+ 500: ErrorResponse;
2903
+ /**
2904
+ * Service Unavailable
2905
+ */
2906
+ 503: ErrorResponse;
2907
+ };
2908
+ export type InternalCreateReplyError = InternalCreateReplyErrors[keyof InternalCreateReplyErrors];
2909
+ export type InternalCreateReplyResponses = {
2910
+ /**
2911
+ * Returns the created reply
2912
+ */
2913
+ 200: {
2914
+ reply: {
2915
+ replyId: string;
2916
+ author: {
2917
+ dazlUserId: string;
2918
+ };
2919
+ content: string;
2920
+ mentions: Array<UserMention>;
2921
+ createdAt: string;
2922
+ updatedAt: string;
2923
+ };
2924
+ };
2925
+ };
2926
+ export type InternalCreateReplyResponse = InternalCreateReplyResponses[keyof InternalCreateReplyResponses];
2927
+ export type InternalDeleteReplyData = {
2928
+ body?: never;
2929
+ path: {
2930
+ projectId: string;
2931
+ commentId: string;
2932
+ replyId: string;
2933
+ };
2934
+ query?: never;
2935
+ url: '/project/{projectId}/comments/{commentId}/replies/{replyId}';
2936
+ };
2937
+ export type InternalDeleteReplyErrors = {
2938
+ /**
2939
+ * Bad request - Invalid parameters or malformed JSON
2940
+ */
2941
+ 400: {
2942
+ message: string;
2943
+ issues?: string;
2944
+ };
2945
+ /**
2946
+ * Unauthorized
2947
+ */
2948
+ 401: ErrorResponse;
2949
+ /**
2950
+ * Forbidden
2951
+ */
2952
+ 403: ErrorResponse;
2953
+ /**
2954
+ * Not Found
2955
+ */
2956
+ 404: ErrorResponse;
2957
+ /**
2958
+ * Conflict
2959
+ */
2960
+ 409: ErrorResponse;
2961
+ /**
2962
+ * Internal server error
2963
+ */
2964
+ 500: ErrorResponse;
2965
+ /**
2966
+ * Service Unavailable
2967
+ */
2968
+ 503: ErrorResponse;
2969
+ };
2970
+ export type InternalDeleteReplyError = InternalDeleteReplyErrors[keyof InternalDeleteReplyErrors];
2971
+ export type InternalDeleteReplyResponses = {
2972
+ /**
2973
+ * Acknowledges that the reply was deleted
2974
+ */
2975
+ 200: {
2976
+ success: true;
2977
+ };
2978
+ };
2979
+ export type InternalDeleteReplyResponse = InternalDeleteReplyResponses[keyof InternalDeleteReplyResponses];
2980
+ export type InternalEditReplyData = {
2981
+ body: InternalEditReplyInput;
2982
+ path: {
2983
+ projectId: string;
2984
+ commentId: string;
2985
+ replyId: string;
2986
+ };
2987
+ query?: never;
2988
+ url: '/project/{projectId}/comments/{commentId}/replies/{replyId}';
2989
+ };
2990
+ export type InternalEditReplyErrors = {
2991
+ /**
2992
+ * Bad request - Invalid parameters or malformed JSON
2993
+ */
2994
+ 400: {
2995
+ message: string;
2996
+ issues?: string;
2997
+ };
2998
+ /**
2999
+ * Unauthorized
3000
+ */
3001
+ 401: ErrorResponse;
3002
+ /**
3003
+ * Forbidden
3004
+ */
3005
+ 403: ErrorResponse;
3006
+ /**
3007
+ * Not Found
3008
+ */
3009
+ 404: ErrorResponse;
3010
+ /**
3011
+ * Conflict
3012
+ */
3013
+ 409: ErrorResponse;
3014
+ /**
3015
+ * Internal server error
3016
+ */
3017
+ 500: ErrorResponse;
3018
+ /**
3019
+ * Service Unavailable
3020
+ */
3021
+ 503: ErrorResponse;
3022
+ };
3023
+ export type InternalEditReplyError = InternalEditReplyErrors[keyof InternalEditReplyErrors];
3024
+ export type InternalEditReplyResponses = {
3025
+ /**
3026
+ * Returns the updated reply
3027
+ */
3028
+ 200: {
3029
+ reply: {
3030
+ replyId: string;
3031
+ author: {
3032
+ dazlUserId: string;
3033
+ };
3034
+ content: string;
3035
+ mentions: Array<UserMention>;
3036
+ createdAt: string;
3037
+ updatedAt: string;
3038
+ };
3039
+ };
3040
+ };
3041
+ export type InternalEditReplyResponse = InternalEditReplyResponses[keyof InternalEditReplyResponses];
2400
3042
  export type GetPublicTemplatesData = {
2401
3043
  body?: never;
2402
3044
  path?: never;
@@ -3326,19 +3968,7 @@ export type ScrapePageContentResponses = {
3326
3968
  images?: {
3327
3969
  [key: string]: unknown;
3328
3970
  } | null;
3329
- [key: string]: unknown | 'light' | 'dark' | null | string | null | {
3330
- [key: string]: unknown;
3331
- } | null | Array<{
3332
- [key: string]: unknown;
3333
- }> | null | {
3334
- [key: string]: unknown;
3335
- } | null | {
3336
- [key: string]: unknown;
3337
- } | null | {
3338
- [key: string]: unknown;
3339
- } | null | {
3340
- [key: string]: unknown;
3341
- } | null | undefined;
3971
+ [key: string]: unknown;
3342
3972
  };
3343
3973
  };
3344
3974
  };