dddddddddzzzz/openstories

The Open Stories format.

openstories's Issues

Require `feed_url` strongly.

The JSON Feed spec states:

feed_url (optional but strongly recommended, string) is the URL of the feed, and serves as the unique identifier for the feed. As with home_page_url, this should be considered required for feeds on the public web.

We should just strongly require feed_url and call it a day, this gives every feed a guaranteed unique identifier to key by.

Make `author.url` required

This should serve as a stable ID of authors across multiple feeds.

Verifying the association between this URL and the feed is tbd.

Format for Preview.color should be specified

I'm inclined to only accept #75ABFF as a format for now, as supporting the whole web color spec seems a little bit much for clients?

Example feed should use ISO 8601 dates

Per the JSON feed spec:

• date_published (optional, string) specifies the date in RFC 3339 format. (Example: 2010-02-07T14:04:00-05:00.)

`alt` and `caption` fields not unique to Image Story,

They are common across Image and Video.

Not a breaking change in the spec actually, just poorly worded.

Create more sample open stories feeds for reference

Good and bad ones.

• Good bears doing the bare minimum 16:9
• Good bears doing the most 16:9
• Valid video feed
• Bad bears with missing fields
• Bad cats 3:2/2:3

`senstivity_warning` has a typo, let's make it `content_warning` instead

Problems loading <open-stories> and Next.js

I'm attempting to load the <open-stories> custom element with Next.js and I seem to be running into a few issues, primarily this is the error I'm getting that is preventing the element from displaying:

TypeError: Cannot set property src of #<OpenStoriesElement> which has only a getter

I'm loading the component client-side like so within a wrapper React component;

'use client'

export default function Stories() {
  return <open-stories src="/api/screenshots"></open-stories>
}

The endpoint resolves to a valid schema, when requested in the browser you get the following:

{"version":"https://jsonfeed.org/version/1.1","title":"Screenshots","_open_stories":{"version":"0.0.9"},"items":[{"id":"2605764403","content_text":"","authors":[{"name":"James","url":"https://jives.dev"}],"_open_stories":{"mime_type":"image/jpg","url":"https://steamuserimages-a.akamaihd.net/ugc/1635359675946958706/E517E16CA053E10ED3EED88E0083F157EBF860E6/","alt":""}}]}

I'm unsure if this error is directly related to Next.js or not. When I exclude the src property from the web component it loads correctly, and you can see the Shadow DOM mount. 🤔

Any help would be super appreciated!