superdesk/superdesk-client-core

import {IArticle, ISuperdeskGlobalConfig} from 'superdesk-api';
import {gettext} from 'core/utils';

/**
  * Global search parameters and label mapping.
 */

export function getParameters() {
    return Object.freeze({
        unique_name: gettext('Unique Name'),
        original_creator: gettext('Creator'),
        from_desk: gettext('From Desk'),
        to_desk: gettext('To Desk'),
        spike: gettext('Spiked'),
        subject: gettext('Subject'),
        company_codes: gettext('Company Codes'),
        marked_desks: gettext('Marked Desks'),
        ingest_provider: gettext('Provider'),
        featuremedia: gettext('Associated Feature Media'),
        subscriber: gettext('Subscriber'),
        firstpublished: gettext('Date published'),
        firstpublishedfrom: gettext('Published from'),
        firstpublishedto: gettext('Published to'),
    });
}

/**
 * Facet field and label mapping and used when facets are removed.
 */
export function getExcludeFacets() {
    return Object.freeze({
        notdesk: gettext('Not Desk'),
        nottype: gettext('Not Type'),
        notgenre: gettext('Not Genre'),
        notcategory: gettext('Not Category'),
        noturgency: gettext('Not Urgency'),
        notsource: gettext('Not Source'),
        notpriority: gettext('Not Priority'),
        notlegal: gettext('Not Legal'),
        notsms: gettext('Not Sms'),
        notlanguage: gettext('Not Language'),
    });
}

/**
 * Default list of fields
 */
export const DEFAULT_LIST_CONFIG: ISuperdeskGlobalConfig['list'] = {
    priority: [
        'priority',
        'urgency',
    ],
    firstLine: [
        'wordcount',
        'slugline',
        'highlights',
        'markedDesks',
        'associations',
        'publish_queue_errors',
        'headline',
        'versioncreated',
    ],
    secondLine: [
        'profile',
        'state',
        'scheduledDateTime',
        'embargo',
        'update',
        'takekey',
        'signal',
        'broadcast',
        'flags',
        'updated',
        'category',
        'provider',
        'expiry',
        'desk',
        'fetchedDesk',
        'nestedlink',
        'associatedItems',
    ],
};

export const DEFAULT_RELATED_ITEMS_LIST_CONFIG = {
    firstLine: [
        'slugline',
        'headline',
        'versioncreated',
    ],
    secondLine: [
        'state',
        'desk',
    ],
};

export const DEFAULT_GRID_VIEW_FIELDS_CONFIG = [
    'source',
];

export const DEFAULT_GRID_VIEW_FOOTER_CONFIG = {
    left: [
        'type',
        'urgency',
        'priority',
    ],
    right: [
        'state',
    ],
};

interface ISwimlaneGroup {
    fields: Array<keyof IArticle>;
    ellipsis?: boolean;
}

export const DEFAULT_SWIMLANE_FIELDS_CONFIG: { [key: string]: Array<ISwimlaneGroup> } = {
    left: [{fields: ['urgency']}, {fields: ['slugline', 'headline'], ellipsis: true}],
    right: [{fields: ['versioncreated']}],
};

/**
 * Core list of fields that has to be returned in search results
 * for core functionality to work
 */
export const CORE_PROJECTED_FIELDS = {
    fields: [
        'highlights',
        '_created',
        '_updated',
        '_etag',
        '_type',
        'state',
        'embargo',
        'embargoed',
        'embargoed_text',
        'publish_schedule',
        'broadcast',
        'flags',
        'rewrite_of',
        'rewritten_by',
        'expiry',
        'task',
        'type',
        'linked_in_packages',
        'renditions',
        'item_id',
        'guid',
        '_current_version',
        'lock_action',
        'lock_user',
        'lock_session',
        'genre',
        'source',
        'language',
        'last_published_version',
        'archived',
        'associations',
        'queue_state',
        'alt_text',
        'description_text',

        'rewrite_sequence',
        'correction_sequence',

        // Added in order not to lose data while drag-and-droping an image to the body | SDESK-1508
        'byline',
        'copyrightholder',
        'copyrightnotice',
        'usageterms',

        // added in order to show the list of items on spiked packages
        'groups',
        'deleted_groups',

        // planning plugin
        'assignment_id',

        // mark for user plugin

        'marked_for_user',

        // translations

        'translated_from',
        'translations',
        'schedule_settings',
    ],
};

/**
 * Mappings of UI fields to schema fields for projection
 */
export const UI_PROJECTED_FIELD_MAPPINGS = {
    priority: 'priority',
    urgency: 'urgency',
    wordcount: 'word_count',
    slugline: 'slugline',
    headline: 'headline',
    profile: 'profile',
    signal: 'signal',
    takekey: 'anpa_take_key',
    update: 'correction_sequence',
    provider: 'ingest_provider',
    category: 'anpa_category',
    versioncreator: 'version_creator',
    versioncreated: 'versioncreated',
    markedDesks: 'marked_desks',
    queueError: 'error_message',
    used: ['used', 'used_updated', 'used_count'],
};