change query, add aprse endpoint

ewilan-riviere · ewilan-riviere · commit 2bc15ae06ede · 2023-08-25T16:59:18.000+02:00
diff --git a/README.md b/README.md
@@ -32,17 +32,33 @@ Default behavior is to return HTML as page. You can use query parameters to chan
 
 Query parameters
 
-| Name   | Required | Description                                                        |
-| ------ | -------- | ------------------------------------------------------------------ |
-| `url`  | true     | URL of RSS feed, allow base64 URL                                  |
-| `html` | false    | Return JSON response with HTML as string                           |
-| `json` | false    | Return JSON response with `Podcast` object, it represents RSS feed |
-| `xml`  | false    | Return XML response with RSS feed                                  |
+| Name     | Required | Type                  | Default     | Description                                                                                                                                   |
+| -------- | -------- | --------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| `url`    | true     | `string`              | `undefined` | URL of RSS feed, allow base64 URL                                                                                                             |
+| `format` | false    | `html`, `json`, `xml` | `html`      | Type of response, default `html` will render HTML page, `json` will give JSON response with HTML string and `xml` will give original RSS feed |
 
 > [!WARNING]\
 > If crawler is not a browser, response will be original XML feed.
 
-Example: <https://feed-renderer.git-projects.xyz/api/renderer?url=https://feeds.acast.com/public/shows/game-of-roles-magic>
+Example: <https://feed-renderer.git-projects.xyz/api/renderer?url=https://2hdp.fr/2HDP.xml>
+
+### Parser
+
+To parse RSS feed, you can use the `/parser` endpoint.
+
+```bash
+/api/parser
+```
+
+Return a JSON response with `Podcast` object represent RSS feed.
+
+Query parameters
+
+| Name  | Required | Type     | Default     | Description                       |
+| ----- | -------- | -------- | ----------- | --------------------------------- |
+| `url` | true     | `string` | `undefined` | URL of RSS feed, allow base64 URL |
+
+Example: <https://feed-renderer.git-projects.xyz/api/parser?url=https://2hdp.fr/2HDP.xml>
 
 ## Installation
 
@@ -119,6 +135,13 @@ Run tests
 pnpm test
 ```
 
+## Roadmap
+
+- [x] Render RSS feed
+- [ ] Add option for apple podcast banner
+- [ ] Add color customization
+- [ ] Add multiple feeds options
+
 ## Credits
 
 - [`unjs`](https://github.com/unjs): for `unjs/h3`, `unjs/ofetch` and `unjs/listhen`
diff --git a/src/components/feed.css b/src/components/feed.css
@@ -32,10 +32,18 @@ header {
 }
 
 .rss {
-  position: absolute;
+  position: fixed;
   z-index: 10;
-  top: 1rem;
-  left: 1rem;
+  top: 0;
+  left: 0;
+  padding: 0.3rem;
+  background-color: rgba(0, 0, 0, 0.5);
+  z-index: 20;
+  border-bottom-right-radius: 0.375rem;
+}
+
+.rss:hover {
+  background-color: rgba(0, 0, 0, 0.75);
 }
 
 .rss svg {
diff --git a/src/components/head.ts b/src/components/head.ts
@@ -29,10 +29,10 @@ export default {
         name: 'viewport',
         content: 'width=device-width, initial-scale=1',
       }),
-      h('meta', {
-        name: 'apple-itunes-app',
-        content: 'app-id=993490336',
-      }),
+      // h('meta', {
+      //   name: 'apple-itunes-app',
+      //   content: 'app-id=993490336',
+      // }),
       h('title', props.title),
       h('link', {
         rel: 'alternate',
diff --git a/src/components/header.ts b/src/components/header.ts
@@ -22,7 +22,7 @@ export default {
 
     return h('header', [
       h('div', { class: 'rss' }, [
-        h('a', { href: props.podcast?.feedUrl, target: '_blank', rel: 'noopener noreferrer', title: 'RSS feed' }, [
+        h('a', { href: props.podcast?.xmlRenderUrl, target: '_blank', rel: 'noopener noreferrer', title: 'RSS feed' }, [
           h('svg', { xmlns: 'http://www.w3.org/2000/svg', viewBox: '0 0 20 20' }, [
             h('g', {}, [
               h('path', { d: 'M3.75 3a.75.75 0 0 0-.75.75v.5c0 .414.336.75.75.75H4c6.075 0 11 4.925 11 11v.25c0 .414.336.75.75.75h.5a.75.75 0 0 0 .75-.75V16C17 8.82 11.18 3 4 3h-.25Z' }),
@@ -41,7 +41,7 @@ export default {
         h('div', { class: 'header-block__description prose' }, [
           h('div', { innerHTML: props.podcast?.description }),
         ]),
-        h('a', { class: 'header-block__button', href: props.podcast?.link }, [
+        h('a', { class: 'header-block__button', href: props.podcast?.feedUrl }, [
           h('svg', { class: 'header-block__button__icon', xmlns: 'http://www.w3.org/2000/svg', viewBox: '0 0 24 24' }, [
             h('path', { fill: 'currentColor', d: 'M11 22v-8.275q-.45-.275-.725-.712T10 12q0-.825.588-1.413T12 10q.825 0 1.413.588T14 12q0 .575-.275 1.025t-.725.7V22h-2Zm-5.9-2.75q-1.425-1.375-2.262-3.238T2 12q0-2.075.788-3.9t2.137-3.175q1.35-1.35 3.175-2.137T12 2q2.075 0 3.9.788t3.175 2.137q1.35 1.35 2.138 3.175T22 12q0 2.15-.838 4.025T18.9 19.25l-1.4-1.4q1.15-1.1 1.825-2.613T20 12q0-3.35-2.325-5.675T12 4Q8.65 4 6.325 6.325T4 12q0 1.725.675 3.225t1.85 2.6L5.1 19.25Zm2.825-2.825q-.875-.825-1.4-1.963T6 12q0-2.5 1.75-4.25T12 6q2.5 0 4.25 1.75T18 12q0 1.325-.525 2.475t-1.4 1.95L14.65 15q.625-.575.988-1.35T16 12q0-1.65-1.175-2.825T12 8q-1.65 0-2.825 1.175T8 12q0 .9.363 1.663T9.35 15l-1.425 1.425Z' }),
           ]),
diff --git a/src/models/Podcast.ts b/src/models/Podcast.ts
@@ -1,10 +1,12 @@
 import { renderDom } from '../components'
 import type { Channel } from '../types'
+import { Dotenv } from '../services'
 import { Episode } from './Episode'
 
 export class Podcast {
   protected constructor(
     public feedUrl: string,
+    public xmlRenderUrl: string,
     public title?: string,
     public description?: string,
     public image?: string,
@@ -32,7 +34,9 @@ export class Podcast {
   ) {}
 
   public static make(feedUrl: string, channel: Channel, lang: string = 'en'): Podcast {
-    const self = new this(feedUrl)
+    const dotenv = Dotenv.load()
+    const xmlRenderUrl = `${dotenv.BASE_URL}/api/renderer?url=${feedUrl}&xml=true`
+    const self = new this(feedUrl, xmlRenderUrl)
 
     self.title = channel.title
     self.description = channel.description
diff --git a/src/router.ts b/src/router.ts
@@ -29,19 +29,17 @@ export const router = createRouter()
         renderer: {
           url: `${dotenv.BASE_URL}/api/renderer`,
           query: {
-            default: 'This endpoint will return HTML render from XML RSS feed, if User-Agent is not a browser, it will return XML RSS feed',
             url: '`string`, required, url to RSS feed (could be base64 encoded)',
-            html: '`boolean`, default: `false`, return HTML data into JSON response',
-            json: '`boolean`, default: `false`, return Podcast object into JSON response',
-            xml: '`boolean`, default: `false`, return XML RSS feed',
+            format: '`html`, `json` or `xml`, optional, default `html`, type of response, default `html` will render HTML page, `json` will give JSON response with HTML string and `xml` will give original RSS feed',
           },
-          about: 'Render HTML from RSS feed',
+          about: 'Render HTML from RSS feed. If User-Agent is not a browser, it will return XML RSS feed',
         },
       },
     }
   }))
   .get('/api/renderer', eventHandler(async (event) => {
     const query = getQuery(event)
+    const format = query.format || 'html'
     const lang = event.node.req.headers['accept-language'] || 'en-US'
     const renderer = await Renderer.make(query, lang)
     const error = renderer.getError()
@@ -52,33 +50,38 @@ export const router = createRouter()
       }
     }
 
-    if (query?.html === 'true') {
+    if (format === 'json') {
       return {
         url: renderer.getUrl(),
         data: await renderer.getRender(),
         date: new Date().toISOString(),
       }
     }
 
-    if (query.json === 'true') {
-      return {
-        url: renderer.getUrl(),
-        data: renderer.getPodcast(),
-        date: new Date().toISOString(),
-      }
-    }
-
-    if (query.xml === 'true') {
+    if (format === 'xml' || !isBrowser(event.node.req.headers['user-agent'])) {
       event.node.res.setHeader('Content-Type', 'text/xml')
 
       return renderer.getXml()
     }
 
-    if (!isBrowser(event.node.req.headers['user-agent'])) {
-      event.node.res.setHeader('Content-Type', 'text/xml')
+    return await renderer.getRender()
+  }))
 
-      return renderer.getXml()
+  .get('/api/parser', eventHandler(async (event) => {
+    const query = getQuery(event)
+    const lang = event.node.req.headers['accept-language'] || 'en-US'
+    const renderer = await Renderer.make(query, lang)
+    const error = renderer.getError()
+
+    if (error) {
+      return {
+        error,
+      }
     }
 
-    return await renderer.getRender()
+    return {
+      url: renderer.getUrl(),
+      data: renderer.getPodcast(),
+      date: new Date().toISOString(),
+    }
   }))
