webstories-ts-types v0.0.6

webstories-ts-types

WebStoriesFeed is an extended version of JSONFeed, which aims to standardize a feed format built speficially for a type of media similar to an Instagram story.

You can validate a WebStoriesFeed in the TypeScript Playground.

A minimum WebStoriesFeed may look like the following; note, specficially the required _web_story object for each item.

{
  version: 'https://jsonfeed.org/version/1.1',
  title: 'Valid feed',
  home_page_url: 'https://example.com',
  feed_url: 'https://example.com/feed.json',
  items: [{
    id: 'a1',
    content_text: 'Text',
    authors: [{name: 'muan'}],
    _web_story: {
      type: 'image',
      mime_type: 'image/jpg',
      url: 'https://photos.muan.dev/cdn-cgi/imagedelivery/-wp_VgtWlgmh1JURQ8t1mg/9324c569-55a2-4f28-4c0e-dbf5ad04d000/public',
      alt: 'Sky'
    }
  }, {
    id: 'a2',
    content_text: 'Text 2',
    authors: [{name: 'muan'}],
    _web_story: {
      type: 'image',
      mime_type: 'image/jpg',
      url: 'https://photos.muan.dev/cdn-cgi/imagedelivery/-wp_VgtWlgmh1JURQ8t1mg/9324c569-55a2-4f28-4c0e-dbf5ad04d000/public',
      alt: 'Sky'
    }
  }]
}