@ta-interaktiv/newsnet-api-flow-types

Newsnet API Flow Types

Flow typing for the stuff the Newsnet API produces.

API

Author

• See: Article

Author object, being part of /api/articles/<legacy_id>

Type: {type: string, id: string, name: string, description: string?, url: string, picture: string?, twitter: string?, rss: string}

Properties

• type string
• id string
• name string
• description string?
• url string
• picture string?
• twitter string?
• rss string

CommunityType

The available types of communities so far.

Type: ("dark" | "facebook" | "twitter" | "whatsapp" | "share" | "comment")

DateString

Date string, of the form "dd.MM.YYYY HH:mm:SS".

Type: string

Community

Community object, used for providing social media information.

Type: {type: CommunityType, count: number, article_id: string, refresh: DateString, cache: (string | boolean), share_type_id: string, url: string?, description: string?, name: string?, title: string?, description: string?, facebook_id: string?, via: string?, allow_comments_weekdays: boolean?, allow_comments_weekends: boolean?, comment_count_text: string?}

Properties

• type CommunityType
• count number
• article_id string
• refresh DateString
• cache (string | boolean)
• share_type_id string
• url string?
• description string?
• name string?
• title string?
• description string?
• facebook_id string?
• via string?
• allow_comments_weekdays boolean?
• allow_comments_weekends boolean?
• comment_count_text string?

Communities

Community list, as provided by /api/articles/<legacy_id>/communities

Type: {communities: Array<Community>}

Properties

• communities Array<Community>

External_Services

External services combines several meta data about an article.

Provided by /api/articles/<legacy_id>/external_services

Type: {configs: any, paywall: any, ads: any, statistics: Array<Statistic>, communities: Array<Community>}

Properties

• configs any
• paywall any
• ads any
• statistics Array<Statistic>
• communities Array<Community>

Statistic

• See: Article

Basic statistic object.

Part of /api/articles/<legacy_id> and /api/articles/<legacy_id>/external_services.

Type: {provider: ("wemf" | "webseismo" | "gtm"), type: string}

Properties

• provider ("wemf" | "webseismo" | "gtm")
• type string

Article

The article type, as provided by the Newsnet API.

Provided by /api/articles/<legacy_id>

Type: {article: ArticleContent}

Properties

• article ArticleContent

ArticleContent

• See: Article

The contents of an article. The API wraps these contents below an article key.

Type: {id: string, legacy_id: number, title: string, title_short: string, picture_small_url: string, picture_medium_url: string, picture_big_url: string, lead: string, lead_short: string, lead_teaser: string, timestamp_updated_at: number, first_published_at: number, external_services: {statistics: Array<Statistic>, ads: any, paywall: any}, authors: Array<Author>}

Properties

• id string
• legacy_id number
• title string
• title_short string
• picture_small_url string
• picture_medium_url string
• picture_big_url string
• lead string
• lead_short string
• lead_teaser string
• timestamp_updated_at number
• first_published_at number
• external_services {statistics: Array<Statistic>, ads: any, paywall: any}
• external_services.statistics Array<Statistic>
• external_services.ads any
• external_services.paywall any
• authors Array<Author>

Site

General information about the site.

Provided by /api/sites/default

Type: {site: SiteContent}

Properties

• site SiteContent

SiteContent

Common information about the site.

Type: {id: string, name_short: string, name: string, title: string, language: string, feedback_url: string, facebook_id: string, facebook_url: string, twitter_via: string, gtm_id: string, paywall_status: number, statistics: Array<Statistic>, external_services: {statistics: Array<Statistic>}}

Properties

• id string
• name_short string
• name string
• title string
• language string
• feedback_url string
• facebook_id string
• facebook_url string
• twitter_via string
• gtm_id string
• paywall_status number
• statistics Array<Statistic>
• external_services {statistics: Array<Statistic>}
• external_services.statistics Array<Statistic>

Contributing

Development

Building & Releasing

Changes should go into the changelog. The format is based on Keep a Changelog and this project adheres to Semantic Versioning. Update the changelog using the last commit messages since the last version tag using

yarn run changelog

Update the Readme with the current API using

yarn run docs