-
Notifications
You must be signed in to change notification settings - Fork 87
/
superdesk-api.d.ts
3719 lines (3212 loc) · 123 KB
/
superdesk-api.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* tslint:disable */
declare module 'superdesk-api' {
// TYPESCRIPT TYPES
type OrderedMap<K, V> = import('immutable').OrderedMap<K, V>;
export interface DeepReadonlyArray<T> extends ReadonlyArray<DeepReadonly<T>> {};
export type DeepReadonlyObject<T> = {
readonly [P in keyof T]: DeepReadonly<T[P]>;
}
export type DeepReadonly<T> =
T extends Function
? T
: T extends Array<infer U>
? DeepReadonlyArray<U>
: DeepReadonlyObject<T>;
export type Omit<K, V> = Pick<K, Exclude<keyof K, V>>;
export type IArrayKeyed<T> = Array<{key: string; value: T}>;
export type ICallable = (...args: Array<any>) => any;
// FORMATS
// AUTHORING-REACT
export interface IAuthoringFieldV2 {
id: string;
name: string;
fieldType: string;
fieldConfig: unknown & Partial<ICommonFieldConfig>;
}
export type IFieldsV2 = OrderedMap<string, IAuthoringFieldV2>;
export interface IContentProfileV2 {
id: string;
name: string;
header: IFieldsV2;
content: IFieldsV2;
}
/**
* in some cases e.g. autosave it is desirable to get an incomplete entity for performance reasons
* by skipping derived data
*/
export type IStoreValueIncomplete = boolean;
export interface IFieldAdapter<T> {
getFieldV2: (
fieldEditor,
fieldSchema,
// If a field depends on another field being present in the editor
// this function is used to check the presence of that dependency field
fieldExists: (fieldId: string) => boolean
) => IAuthoringFieldV2;
/**
* Allows to customize where values are stored.
*
* By default, custom fields are stored in IArticle['extra'].
* Some fields may require a different storing strategy.
* For example, editor3 fields need to store `RawDraftContentState` in `IArticle['fields_meta']`
* HTML or plaintext version of the data in another location, and possibly annotations in third location.
*/
storeValue?(value: unknown, article: T, config: unknown, preferIncomplete: IStoreValueIncomplete): T;
/**
* If defined, {@link ICustomFieldType.retrieveStoredValue} will not be used
*/
retrieveStoredValue?(item: T, authoringStorage: IAuthoringStorage<T>): unknown;
/**
* Must return a value in operational format.
*/
onToggledOn?: ICustomFieldType<unknown, unknown, unknown, unknown>['onToggledOn'];
}
export type IFieldsAdapter<T> = {[key: string]: IFieldAdapter<T>};
export interface IStorageAdapter<T> {
storeValue(value: unknown, fieldId: string, entity: T, config: unknown, fieldType: string): T;
retrieveStoredValue(item: T, fieldId: string, fieldType: string): unknown;
}
export interface IAuthoringAutoSave<T> {
get(id: string): Promise<T>;
delete(id: string, etag: string): Promise<void>;
cancel(): void;
/**
* A function that returns the article is used to improve performance.
* In order to get the latest article, data has to be serialized. Using a function
* allows to only do it once after timeout passes, instead of on every character change.
*/
schedule(getItem: () => T, callback: (autosaved: T) => void): void;
/**
* Immediately autosaves without a delay if there is anything to autosave.
* Is meant to be used before unmounting the component.
*/
flush(): Promise<void>;
}
/**
* {@link AuthoringReact} component will use this interface
* instead of making network calls directly.
* Alternative implementation can be used
* to enable offline support.
*/
export interface IAuthoringStorage<T> {
forceLock(entity: T): Promise<T>;
isLockedInCurrentSession(item: T): boolean;
getEntity(id: string): Promise<{saved: T | null, autosaved: T | null}>;
saveEntity(current: T, original: T): Promise<T>;
closeAuthoring(
current: T,
original: T,
cancelAutosave: () => Promise<void>,
doClose: () => void,
): Promise<void>;
getContentProfile(item: T, fieldsAdapter: IFieldsAdapter<T>): Promise<IContentProfileV2>;
getUserPreferences(): Promise<any>;
autosave: IAuthoringAutoSave<T>;
}
export type IFieldsData = import('immutable').Map<string, unknown>;
/**
* Check authoring-react.tsx for comments on individual methods.
*/
export interface IExposedFromAuthoring<T> {
item: T;
sideWidget: string | null; // side widget id
/**
* Computes the latest entity from fields data. `item` property in
* this interface holds a bit of an older version of the item.
* It is expensive to compute it on every render, that's why
* we are passing a function instead.
*/
getLatestItem(options?: {preferIncomplete?: IStoreValueIncomplete}): T;
toggleSideWidget(id: string | null): void;
contentProfile: IContentProfileV2;
fieldsData: IFieldsData;
authoringStorage: IAuthoringStorage<T>;
storageAdapter: IStorageAdapter<T>;
fieldsAdapter: IFieldsAdapter<T>;
hasUnsavedChanges(): boolean;
handleUnsavedChanges(): Promise<T>;
handleFieldsDataChange(fieldsData: IFieldsData): void;
onItemChange(item: T): void;
save(): Promise<T>;
initiateClosing(): void;
keepChangesAndClose(): void;
stealLock(): void;
}
export interface IAuthoringOptions<T> {
readOnly: boolean;
actions: Array<ITopBarWidget<T>>;
toolbarBgColor?: React.CSSProperties['backgroundColor'];
}
export interface ITopBarWidget<T> {
component: React.ComponentType<{entity: T}>;
availableOffline: boolean;
priority: IDisplayPriority;
group: 'start' | 'middle' | 'end';
keyBindings?: IKeyBindings;
}
interface IPropsAuthoring<T> {
itemId: string;
/**
* Used for listening for updates via web sockets.
* An empty array may be passed if updates do not apply i.e. when an editing an item embedded inside another DB record
*/
resourceNames: Array<string>;
// Hides the toolbar which includes the "Print Preview" button.
hideSecondaryToolbar?: boolean;
getLanguage(entity: T): string;
onClose(): void;
authoringStorage: IAuthoringStorage<T>;
storageAdapter: IStorageAdapter<T>;
fieldsAdapter: IFieldsAdapter<T>;
getActions?(options: IExposedFromAuthoring<T>): Array<IAuthoringAction>; // three dots menu actions
getInlineToolbarActions?(options: IExposedFromAuthoring<T>): IAuthoringOptions<T>;
getAuthoringPrimaryToolbarWidgets?(
options: IExposedFromAuthoring<T>,
): Array<ITopBarWidget<T>>;
onEditingStart?(item: T): void;
onEditingEnd?(item: T): void;
// positioned relatively; shown at the same time as getSidePanel
// used for rendering icon buttons of available side widgets
getSidebar?(options: IExposedFromAuthoring<T>): JSX.Element | null;
// positioned absolutely; shown at the same time as getSidebar
// used for side widgets
getSidePanel?(options: IExposedFromAuthoring<T>, readOnly: boolean): React.ReactNode;
secondaryToolbarWidgets: Array<React.ComponentType<{item: T}>>;
disableWidgetPinning?: boolean; // defaults to false
getSidebarWidgetsCount(options: IExposedFromAuthoring<T>): number;
sideWidget: null | {
id: string;
pinned: boolean;
};
getSideWidgetIdAtIndex(item: T, index: number): string;
onSideWidgetChange(openWidget: IPropsAuthoring<T>['sideWidget']): void;
// Runs before re-render.
onFieldChange?(
fieldId: string,
fieldsData: IFieldsData,
computeLatestEntity: IExposedFromAuthoring<T>['getLatestItem'],
): IFieldsData;
validateBeforeSaving?: boolean; // will block saving if invalid. defaults to true
headerCollapsed?: boolean; // initial value
themingEnabled?: boolean; // only works with article; default false
autoFocus?: boolean; // defaults to true; will focus first input
}
// AUTHORING-REACT FIELD TYPES - attachments
export type IAttachmentsValueOperational = Array<{id: IAttachment['_id']}>;
export type IAttachmentsValueStorage = IAttachmentsValueOperational;
export type IAttachmentsUserPreferences = never;
export type IAttachmentsConfig = ICommonFieldConfig;
// AUTHORING-REACT FIELD TYPES - date
export type IDateValueOperational = string;
export type IDateValueStorage = IDateValueOperational;
export type IDateUserPreferences = never;
export interface IDateShortcut {
label: string;
value: number;
term: 'days' | 'weeks' | 'months' | 'years';
}
export interface IDateFieldConfig extends ICommonFieldConfig {
shortcuts?: Array<IDateShortcut>;
}
// AUTHORING-REACT FIELD TYPES - date
export interface ILocated {
/** dateline format - list of fields which should be used to identify the place */
dateline: 'city' | 'city,state' | 'city,country' | 'city,state,country';
city: string;
state: string;
country: string;
city_code: string;
state_code: string;
country_code: string;
/** timezone identifier, eg. Europe/Prague */
tz: string;
/** scheme identifier */
scheme: string;
/** code for place in the scheme */
code: string;
/** geonames place data */
place?: IGeoName;
}
export type IDatelineValueOperational = {
date?: string;
source?: string;
located?: ILocated;
text?: string;
};
export type IDatelineValueStorage = IDatelineValueOperational;
export type IDatelineUserPreferences = never;
export interface IDatelineFieldConfig extends ICommonFieldConfig {}
// AUTHORING-REACT FIELD TYPES - time
export type ITimeValueOperational = string; // ISO 8601, 13:59:01.123
export type ITimeValueStorage = ITimeValueOperational;
export interface ITimeFieldConfig extends ICommonFieldConfig {
allowSeconds?: boolean;
};
export type ITimeUserPreferences = never;
// AUTHORING-REACT FIELD TYPES - tag input
export type ITagInputValueOperational = Array<string> | null;
export type ITagInputValueStorage = ITagInputValueOperational;
export interface ITagInputFieldConfig extends ICommonFieldConfig {};
export type ITagInputUserPreferences = never;
// AUTHORING-REACT FIELD TYPES - duration
export type IDurationValueOperational = number; // number of seconds
export type IDurationValueStorage = IDurationValueOperational;
export type IDurationFieldConfig = never;
export type IDurationUserPreferences = never;
// AUTHORING-REACT FIELD TYPES - dropdown
export interface ITreeWithLookup<T> {
nodes: Array<ITreeNode<T>>;
lookup: {
[id: string]: ITreeNode<T>;
};
}
export type IDropdownValue = unknown;
export interface IDropdownOption {
id: string | number;
label: string;
parent?: IDropdownOption['id'];
color?: string;
}
export interface IDropdownConfigVocabulary extends ICommonFieldConfig {
source: 'vocabulary';
vocabularyId: IVocabulary['_id'];
multiple: boolean;
filter?(vocabulary: IVocabularyItem): boolean;
}
export interface IDropdownConfigRemoteSource extends ICommonFieldConfig {
source: 'remote-source';
searchOptions(
searchTerm: string,
language: string,
callback: (result: ITreeWithLookup<unknown>) => void,
): void;
getLabel(item: unknown): string;
getId(item: unknown): string;
canSelectBranchWithChildren?(branch: ITreeNode<unknown>): boolean;
optionTemplate?: React.ComponentType<{item: unknown}>;
valueTemplate?: React.ComponentType<{item: unknown}>;
multiple: boolean;
}
export interface IDropdownTreeConfig extends ICommonFieldConfig {
source: 'dropdown-tree';
getItems(): ITreeWithLookup<unknown>;
getLabel(item: unknown): string;
getId(item: unknown): string;
canSelectBranchWithChildren?(branch: ITreeNode<unknown>): boolean;
optionTemplate?: React.ComponentType<{item: unknown}>;
valueTemplate?: React.ComponentType<{item: unknown}>;
multiple: boolean;
}
export interface IDropdownConfigManualSource extends ICommonFieldConfig {
source: 'manual-entry';
type: 'text' | 'number';
options: Array<IDropdownOption>;
roundCorners: boolean;
multiple: boolean;
}
export type IDropdownConfig =
IDropdownConfigManualSource
| IDropdownConfigVocabulary
| IDropdownConfigRemoteSource
| IDropdownTreeConfig;
// AUTHORING-REACT FIELD TYPES - editor3
export interface IEditor3ValueOperational {
store: import('redux').Store<any>; // IEditorStore
contentState: import('draft-js').ContentState;
}
export interface IEditor3ValueStorage {
rawContentState: import('draft-js').RawDraftContentState;
}
export interface IEditor3Config extends ICommonFieldConfig {
editorFormat?: Array<RICH_FORMATTING_OPTION>;
minLength?: number;
maxLength?: number;
singleLine?: boolean; // also limits to plain text
cleanPastedHtml?: boolean;
disallowedCharacters?: Array<string>;
// Users may configure predefined text
// snippets to append to the field
vocabularyId?: string;
// read time, character count, word count; defaults to true
showStatistics?: boolean;
// allows having another component control the field value
// e.g. picking from a custom vocabulary with predefined values
helperComponent?: React.ComponentType<{
onChange: (value: IEditor3ValueOperational) => void;
language: string;
readOnly: boolean;
}>;
/**
* Value - field ID of editor3 field.
*
* When this field is toggled on, it will initialize with a value
* copied from a field with ID specified in this config.
*
* Only plaintext value is copied to avoid target field containing
* invalid formatting options that may be valid in source field.
*/
copyFromFieldOnToggle?: string;
}
// AUTHORING-REACT FIELD TYPES - embed
export interface IEmbedValueOperational {
embed: string; // embed code
description: string;
}
export type IEmbedValueStorage = IEmbedValueOperational;
export type IEmbedUserPreferences = never;
export type IEmbedConfig = ICommonFieldConfig;
// AUTHORING-REACT FIELD TYPES - linked items
interface ILinkedItem {
id: IArticle['_id'];
// type is only needed for compatibility with angular based authoring
type: IArticle['type'];
}
export type ILinkedItemsValueOperational = Array<ILinkedItem>;
export type ILinkedItemsValueStorage = ILinkedItemsValueOperational;
export type ILinkedItemsUserPreferences = never;
export type ILinkedItemsConfig = ICommonFieldConfig;
// AUTHORING-REACT FIELD TYPES - packages
interface IPackageItem {
type: IArticle['type'];
headline: string;
residRef: string;
location: string;
slugline: string;
renditions: {};
itemClass: string;
guid: string;
}
export type IPackageItemsValueOperational = Array<IPackageItem>;
export type IPackageItemsValueStorage = IPackageItemsValueOperational;
export type IPackageItemsUserPreferences = never;
export type IPackageItemsConfig = ICommonFieldConfig;
// AUTHORING-REACT FIELD TYPES - media
export type IMediaValueOperational = Array<IArticle>;
export type IMediaValueStorage = IMediaValueOperational;
export type IMediaUserPreferences = never;
export interface IMediaConfig extends ICommonFieldConfig {
maxItems?: number;
allowPicture?: boolean;
allowVideo?: boolean;
allowAudio?: boolean;
showPictureCrops?: boolean;
showTitleEditingInput?: boolean;
allowedWorkflows?: {
inProgress?: boolean;
published?: boolean;
};
}
// AUTHORING-REACT FIELD TYPES - urls
export interface IUrlObject {
url: string;
description: string;
}
export type IUrlsFieldValueOperational = Array<IUrlObject>;
export type IUrlsFieldValueStorage = IUrlsFieldValueOperational;
export type IUrlsFieldUserPreferences = never;
export type IUrlsFieldConfig = ICommonFieldConfig;
// EDITOR3
export interface IEditor3Output {
stringValue: string; // HTML or plain text (depending on config)
annotations: Array<any>;
}
// EXTENSIONS
export type onSpikeMiddlewareResult = {warnings?: Array<{text: string}>};
export type onPublishMiddlewareResult= {warnings?: Array<{text: string}>};
/**
* float number 0 < x < 1. Larger the number, closer the component will be rendered to its side.
* for example, if we had a list with 'start' positioned items with the following priorities [0.1, 0.2, 0.3]
* we could add an item so it's the first in the list by setting priority to be less than 0.1, for example, 0.05.
* to insert an item between 0.2 and 0.3 we could set its priority to 0.25
* See [[sortByDisplayPriority]] for debug information.
*/
export type IDisplayPriority = number;
/**
* EXAMPLE: `{'ctrl+shift+s': () => save()}`
*/
export interface IKeyBindings {
[key: string]: () => void;
}
export interface IAuthoringAction {
groupId?: string; // action lists can specify which groups they wanna render via an id
priority?: IDisplayPriority;
icon?: string;
label: string;
onTrigger(): void;
keyBindings?: IKeyBindings;
}
export interface IArticleActionBulk {
priority?: IDisplayPriority;
label: string;
icon: string;
group?: {label: string, icon: string};
onTrigger(): void;
}
export interface IMonitoringFilter {
label: string;
query: {[key: string]: any};
displayOptions?: {
ignoreMatchesInSavedSearchMonitoringGroups?: boolean;
};
}
export interface IPersonalSpaceSection {
label: string;
id: string,
query: {[key: string]: any};
}
export interface IAuthoringWidgetLayoutProps {
header?: JSX.Element;
body: JSX.Element;
footer?: JSX.Element;
// only works react based authoring
background?: 'light' | 'grey';
}
export interface IGenericSidebarComponentProps<T> {
entityId: string;
readOnly: boolean;
contentProfile: IContentProfileV2;
fieldsData: OrderedMap<string, unknown>;
authoringStorage: IAuthoringStorage<T>;
fieldsAdapter: IFieldsAdapter<T>;
storageAdapter: IStorageAdapter<T>;
onFieldsDataChange(fieldsData?: OrderedMap<string, unknown>): void;
/**
* Will prompt user to save changes. The promise will get rejected if user cancels saving.
*/
handleUnsavedChanges(): Promise<T>;
}
export interface IGenericSideWidget<T> {
_id: string; // required for configuring widget visibility in content profile
label: string;
order: number; // Integer. // NICE-TO-HAVE: manage order in the UI instead of here
icon: string;
component: React.ComponentType<IGenericSidebarComponentProps<T>>;
isAllowed: (entity: T) => boolean;
}
export interface IArticleSideWidgetComponentType {
article: IArticle;
getLatestArticle: IExposedFromAuthoring<IArticle>['getLatestItem'];
initialState?: any;
// other props below are specific to authoring-react implementation
readOnly: boolean;
contentProfile?: IContentProfileV2;
fieldsData?: OrderedMap<string, unknown>;
authoringStorage: IAuthoringStorage<IArticle>;
fieldsAdapter: IFieldsAdapter<IArticle>;
storageAdapter: IStorageAdapter<IArticle>;
onItemChange?(article: IArticle): void;
onFieldsDataChange?(fieldsData?: OrderedMap<string, unknown>): void;
/**
* Will prompt user to save changes. The promise will get rejected if user cancels saving.
*/
handleUnsavedChanges(): Promise<IArticle>;
}
/**
* @deprecated: prefer {@link IGenericSideWidget}
*/
export interface IArticleSideWidget {
_id: string; // required for configuring widget visibility in content profile
label: string;
order: number; // Integer. // NICE-TO-HAVE: manage order in the UI instead of here
icon: string;
component: React.ComponentType<IArticleSideWidgetComponentType>;
isAllowed?(article: IArticle): boolean; // enables limiting widgets depending on article data
}
export type IComment = {
_id: string;
text: string;
item: string;
user?: IUser;
mentioned_users?: {[key: string]: IUser['_id']};
mentioned_desks?: {[key: string]: IDesk['_id']};
_updated?: string;
_created: string;
};
export interface AuthoringHeaderItem {
_id: string;
label: string;
order: number;
component: React.ComponentType<{article: IArticle}>;
}
export interface IIngestRule<ExtraAttributes = {}> {
name: string;
handler: string;
filter?: any;
actions: A & {
fetch?: Array<F>;
publish?: Array<P>;
exit?: boolean;
preserve_desk?: boolean;
extra?: ExtraAttributes;
};
schedule?: {
day_of_week: Array<'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT' | 'SUN'>;
hour_of_day_from?: string;
hour_of_day_to?: string;
time_zone?: string;
_allDay: boolean;
};
}
export interface IIngestRuleHandler extends IBaseRestApiResponse {
name: string;
supported_actions: {
fetch_to_desk: boolean;
publish_from_desk: boolean;
};
supported_configs: {
exit: boolean;
preserve_desk: boolean;
};
default_values: IIngestRule;
}
export interface IIngestRuleHandlerEditorProps<ExtraAttributes = {}> {
rule: IIngestRule<ExtraAttributes>;
updateRule(rule: IIngestRule<ExtraAttributes>): void;
}
export interface IIngestRuleHandlerPreviewProps<ExtraAttributes = {}> {
rule: IIngestRule<ExtraAttributes>;
}
export interface IIngestRuleHandlerExtension {
editor?: React.ComponentType<IIngestRuleHandlerEditorProps>;
preview?: React.ComponentType<IIngestRuleHandlerPreviewProps>;
}
interface IEmailNotification {
type: 'email';
}
export interface IDesktopNotification {
type: 'desktop';
label: string;
handler: (notification: any) => {
body: string;
actions: Array<{label: string; onClick: () => void;}>;
};
}
export interface IExtensionActivationResult {
contributions?: {
globalMenuHorizontal?: Array<React.ComponentType>;
editor3?: {
annotationInputTabs?: Array<IEditor3AnnotationInputTab>;
}
articleListItemWidgets?: Array<React.ComponentType<{article: IArticle}>>;
articleGridItemWidgets?: Array<React.ComponentType<{article: IArticle}>>;
/**
* Display custom components at the top of authoring panel
*/
authoringTopbarWidgets?: Array<{
component: React.ComponentType<{article: IArticle}>;
availableOffline: boolean;
priority: IDisplayPriority;
group: 'start' | 'middle' | 'end';
}>;
/**
* Display custom components in the second toolbar in authoring panel
*/
authoringTopbar2Widgets?: Array<React.ComponentType<{article: IArticle}>>;
authoringSideWidgets?: Array<IArticleSideWidget>;
authoringHeaderComponents?: Array<AuthoringHeaderItem>;
getAuthoringActions?(
article: IArticle,
contentProfile: IContentProfileV2,
fieldsData: import('immutable').Map<string, unknown>,
): Array<IAuthoringAction>;
mediaActions?: Array<React.ComponentType<{article: IArticle}>>;
pages?: Array<IPage>;
workspaceMenuItems?: Array<IWorkspaceMenuItem>;
customFieldTypes?: Array<ICustomFieldType>;
notifications?: {
[id: string]: IEmailNotification | IDesktopNotification;
};
entities?: {
article?: {
getActions?(article: IArticle): Array<IAuthoringAction>;
getActionsBulk?(articles: Array<IArticle>): Promise<Array<IArticleActionBulk>>;
onPatchBefore?(id: IArticle['_id'], patch: Partial<IArticle>, dangerousOptions?: IDangerousArticlePatchingOptions,): Promise<Partial<IArticle>>; // can alter patch(immutably), can cancel patching
onSpike?(item: IArticle): Promise<onSpikeMiddlewareResult>;
onSpikeMultiple?(items: Array<IArticle>): Promise<onSpikeMiddlewareResult>;
onPublish?(item: IArticle): Promise<onPublishMiddlewareResult>;
onRewriteAfter?(item: IArticle): Promise<IArticle>;
onSendBefore?(items: Array<IArticle>, desk: IDesk): Promise<void>;
onTranslateAfter?(original: IArticle, translation: IArticle): void;
};
ingest?: {
ruleHandlers?: {[key: string]: IIngestRuleHandlerExtension};
};
};
iptcMapping?(data: Partial<IPTCMetadata>, item: Partial<IArticle>, parent?: IArticle): Promise<Partial<IArticle>>;
searchPanelWidgets?: Array<React.ComponentType<ISearchPanelWidgetProps<unknown>>>;
authoring?: {
/**
* Updates can be intercepted and modified. Return value will be used to compute a patch.
*
* Example: onUpdateBefore = (current, next) => ({...next, priority: next.headline.includes('important') ? 10 : 1})
*/
onUpdateBefore?(current: IArticle, next: IArticle): Promise<IArticle>;
/** Called after the update. */
onUpdateAfter?(previous: IArticle, current: IArticle): void;
onCloseAfter?(item: IArticle): void;
};
monitoring?: {
getFilteringButtons?(deskId: string): Array<IMonitoringFilter>;
};
personalSpace?: {
getSections?(): Array<IPersonalSpaceSection>;
};
/**
* Extra vertical sections may be added to the publishing panel.
*/
publishingSections?: Array<{component: React.ComponentType<{item: IArticle}>}>;
}
}
export type ISearchPanelWidgetProps<T> = {
provider: string;
params: T;
setParams: (params: Partial<T>) => void;
};
export type IExtension = DeepReadonly<{
activate: (superdesk: ISuperdesk) => Promise<IExtensionActivationResult>;
exposes?: {[key: string]: any};
}>;
export type IExtensionObject = {
extension: IExtension;
activationResult: IExtensionActivationResult;
configuration: {[key: string]: {}};
};
export interface IExtensionModule {
default: IExtension;
};
export type IExtensions = {[key: string]: IExtensionObject};
export type ISideMenuItem = DeepReadonly<{
label: string;
url: string;
}>;
// ENTITIES
export interface IAuthor {
// !!! _id is optional. It will not be present in ingested items.
_id?: [string, string]; // user id, role
name: string;
scheme: any | null;
user: IUser;
role?: string;
parent?: string;
sub_label?: string;
private?: boolean; //Author wants to be publicly visible or hidden [SDBELGA-605]
}
// to use as a value, use enum inside 'scripts/apps/search/interfaces.ts'
export enum ITEM_STATE {
/**
* ROOT STATE
* DRAFT is the first state for manually created items. Drafts can only be autosaved.
* When a draft is saved manually, the state switches to IN_PROGRESS.
*/
DRAFT = 'draft',
/**
* READ-ONLY, ROOT STATE
* Ingested item in ingest collection, not production.
* The only action that can be performed on ingested items is to fetch them.
* After fetching, state switches to FETCHED.
*/
INGESTED = 'ingested',
/**
* Item manually fetched from ingest to desk.
* Similar to ROUTED, except that fetching is manual and routing is automatic.
* Same actions are available as for items that are IN_PROGRESS
*/
FETCHED = 'fetched', // becomes IN_PROGRESS when you start editing it
/**
* Automatically ingested to desk.
* Similar to FETCHED, except that routing is automatic and fetching is manual.
* Same actions are available as for items that are IN_PROGRESS
*/
ROUTED = 'routed',
/**
* Item is sent to a desk.
* Same actions are available as for items that are IN_PROGRESS
* becomes IN_PROGRESS when a change is saved
*/
SUBMITTED = 'submitted',
/**
* Main workflow state.
*/
IN_PROGRESS = 'in_progress',
/**
* Removed from a desk.
* The only action that can be performed on SPIKED items is to un-spike.
* SPIKED items may also be removed by the system after a certain period of time.
*/
SPIKED = 'spiked',
/**
* Published.
*
* update - creates a copy -> IN_PROGRESS
* correct - creates a new item with state CORRECTED, can only publish correction, can't get it back to workflow
* takedown -> RECALLED
* kill -> KILLED
* unpublish -> UNPUBLISHED will go in workflow and become IN_PROGRESS when edited
*
*/
PUBLISHED = 'published',
/**
* Scheduled for publishing. Always displayed in output stage.
* The only available action is to de-schedule. Item will then become IN_PROGRESS.
* Unless de-scheduled, the item will become PUBLISHED at set date.
*/
SCHEDULED = 'scheduled',
/**
* Correction is published.
* Will only be displayed in output stage
* Same actions are available as for items that are PUBLISHED
*/
CORRECTED = 'corrected',
/**
* Only available when correction workflow is enabled.
* BEING_CORRECTED state will be set for a formerly published item which is in the output.
* The original item will remain in the output.
* A new item will be created on a stage with status CORRECTION.
*/
BEING_CORRECTED = 'being_corrected',
/**
* Only available when correction workflow is enabled.
* Item with state CORRECTION will be displayed on a stage.
* The original item that is being corrected will remain in the output with state BEING_CORRECTED.
* When published, becomes CORRECTED.
*/
CORRECTION = 'correction',
/**
* FINAL STATE
* No actions are available.
*/
KILLED = 'killed',
/**
* FINAL STATE
* No actions are available.
*/
RECALLED = 'recalled',
/**
* When unpublished, item goes back to workflow and will become IN_PROGRESS if changed and saved.
*/
UNPUBLISHED = 'unpublished',
}
export interface IRelatedArticle {
_id: IArticle['_id'];
type: IArticle['type'];
order: number,
}
export interface IRendition {
href: string;
mimetype: string;
/** media storage id, set when item is stored in superdesk */
media?: string;
// picture and video only
width?: number;
height?: number;
// video id, set when item is stored in video server
video_editor_id?: string;
};
export interface ILockInfo {
_lock: boolean;
// write-only, used to update `_lock`
_lock_action?: 'unlock' | 'lock' | 'force-lock'
_lock_session?: string;
_lock_expiry?: string;
_lock_time?: string;
_lock_user?: IUser['_id'];
}
export interface IPropsLockInfoHttp<T extends ILockInfo> {
entity: T;
/**
* Relative path; will be used for unlocking
*/
endpoint: string;