@screenly/edge-apps 1.0.0-rc.1 → 1.0.0

package/README.md

@@ -6,8 +6,14 @@ A TypeScript library for interfacing with the Screenly Edge Apps API.
 
 ## Installation
 
-> [!IMPORTANT]
-> This package requires [Bun](https://bun.sh). The `edge-apps-scripts` CLI will not work with `npm` or `node` at this time.
+> [!NOTE]
+> Requires Node.js >= 20.6.0.
+
+```bash
+npm install @screenly/edge-apps
+```
+
+Or with Bun:
 
 ```bash
 bun add @screenly/edge-apps
@@ -20,26 +26,22 @@ When developing Edge Apps locally using the library from this repository, you sh
 First, in the root of this repository:
 
 ```bash
-bun link
+npm install
+npm run build
+npm link
 ```
 
 Then in your Edge App directory:
 
 ```bash
 cd /path/to/your-edge-app
-bun link @screenly/edge-apps
+npm link @screenly/edge-apps
 ```
 
 To unlink the package when you're done with local development, run the following in your Edge App directory:
 
 ```bash
-bun install --force
-```
-
-Then in the root of this repository:
-
-```bash
-bun unlink
+npm install
 ```
 
 ## Quick Start
@@ -97,7 +99,7 @@ signalReady()
 
 ## Web Components
 
-This library includes reusable web components for building consistent Edge Apps. See the [components documentation](https://github.com/Screenly/edge-apps-library/blob/master/docs/components.md) for usage details.
+This library includes reusable web components for building consistent Edge Apps. See the [components documentation](https://github.com/Screenly/edge-apps-library/blob/main/docs/components.md) for usage details.
 
 ## Edge Apps Scripts CLI
 
@@ -110,13 +112,13 @@ This package provides the `edge-apps-scripts` CLI tool for running shared develo
 Start the Vite development server with mock data from `screenly.yml` and `mock-data.yml`:
 
 ```bash
-bun run dev
+npm run dev
 ```
 
 #### Building
 
 ```bash
-bun run build
+npm run build
 ```
 
 #### Linting
@@ -124,13 +126,13 @@ bun run build
 To lint your Edge App:
 
 ```bash
-bun run lint
+npm run lint
 ```
 
 To lint and automatically fix issues:
 
 ```bash
-bun run lint -- --fix
+npm run lint -- --fix
 ```
 
 #### Type Checking
@@ -138,7 +140,7 @@ bun run lint -- --fix
 Run TypeScript type checking:
 
 ```bash
-bun run type-check
+npm run type-check
 ```
 
 ### Command-Line Utilities for Edge Apps
@@ -158,7 +160,7 @@ It is recommended to add the following scripts to your Edge App's `package.json`
     "build:dev": "edge-apps-scripts build:dev",
     "lint": "edge-apps-scripts lint",
     "type-check": "edge-apps-scripts type-check",
-    "deploy": "bun run build && screenly edge-app deploy --path=dist/"
+    "deploy": "npm run build && screenly edge-app deploy --path=dist/"
   }
 }
 ```
@@ -197,7 +199,7 @@ import type {
 ## Development
 
 ```bash
-bun install      # Install dependencies
-bun test         # Run tests
-bun run build    # Build library
+npm install      # Install dependencies
+npm test         # Run tests
+npm run build    # Build library
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@screenly/edge-apps",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0",
   "description": "A TypeScript library for interfacing with Screenly Edge Apps API",
   "type": "module",
   "engines": {
@@ -79,6 +79,10 @@
   ],
   "author": "Screenly",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Screenly/edge-apps-library"
+  },
   "publishConfig": {
     "access": "public"
   },

package/scripts/cors-proxy-server.js

@@ -2,6 +2,8 @@ import http from 'http'
 import https from 'https'
 import { URL } from 'url'
 
+const MAX_REDIRECTS = 10
+
 function setCorsHeaders(res) {
   res.setHeader('Access-Control-Allow-Origin', '*')
   res.setHeader(
@@ -12,7 +14,80 @@ function setCorsHeaders(res) {
   res.setHeader('Access-Control-Max-Age', '86400')
 }
 
-function makeProxyRequest(httpModule, parsedUrl, req, res) {
+function handleRedirect(
+  location,
+  req,
+  res,
+  proxyRes,
+  currentUrl,
+  redirectCount,
+) {
+  if (redirectCount >= MAX_REDIRECTS) {
+    proxyRes.resume()
+    res.writeHead(508, { 'Content-Type': 'application/json' })
+    res.end(JSON.stringify({ error: 'Too many redirects' }))
+    return
+  }
+
+  try {
+    const redirectUrl = new URL(location, currentUrl)
+    if (redirectUrl.protocol !== 'http:' && redirectUrl.protocol !== 'https:') {
+      proxyRes.resume()
+      res.writeHead(502, { 'Content-Type': 'application/json' })
+      res.end(JSON.stringify({ error: 'Invalid redirect location' }))
+      return
+    }
+    const redirectModule = redirectUrl.protocol === 'https:' ? https : http
+    proxyRes.resume()
+    makeProxyRequest(redirectModule, redirectUrl, req, res, redirectCount + 1)
+  } catch {
+    proxyRes.resume()
+    res.writeHead(502, { 'Content-Type': 'application/json' })
+    res.end(JSON.stringify({ error: 'Invalid redirect location' }))
+  }
+}
+
+function handleProxyResponse(proxyRes, req, res, currentUrl, redirectCount) {
+  if (
+    proxyRes.statusCode >= 301 &&
+    proxyRes.statusCode <= 308 &&
+    proxyRes.headers.location &&
+    ['GET', 'HEAD'].includes(req.method)
+  ) {
+    handleRedirect(
+      proxyRes.headers.location,
+      req,
+      res,
+      proxyRes,
+      currentUrl,
+      redirectCount,
+    )
+    return
+  }
+
+  const excludeHeaders = [
+    'connection',
+    'keep-alive',
+    'proxy-authenticate',
+    'proxy-authorization',
+    'te',
+    'trailers',
+    'transfer-encoding',
+    'upgrade',
+  ]
+
+  Object.keys(proxyRes.headers).forEach((key) => {
+    if (!excludeHeaders.includes(key.toLowerCase())) {
+      res.setHeader(key, proxyRes.headers[key])
+    }
+  })
+
+  setCorsHeaders(res)
+  res.writeHead(proxyRes.statusCode)
+  proxyRes.pipe(res)
+}
+
+function makeProxyRequest(httpModule, parsedUrl, req, res, redirectCount = 0) {
   const options = {
     hostname: parsedUrl.hostname,
     port: parsedUrl.port || (parsedUrl.protocol === 'https:' ? 443 : 80),
@@ -29,38 +104,15 @@ function makeProxyRequest(httpModule, parsedUrl, req, res) {
   delete options.headers['x-forwarded-proto']
   delete options.headers['x-forwarded-host']
 
-  const proxyReq = httpModule.request(options, (proxyRes) => {
-    const excludeHeaders = [
-      'connection',
-      'keep-alive',
-      'proxy-authenticate',
-      'proxy-authorization',
-      'te',
-      'trailers',
-      'transfer-encoding',
-      'upgrade',
-    ]
-
-    Object.keys(proxyRes.headers).forEach((key) => {
-      if (!excludeHeaders.includes(key.toLowerCase())) {
-        res.setHeader(key, proxyRes.headers[key])
-      }
-    })
-
-    res.writeHead(proxyRes.statusCode)
-    proxyRes.pipe(res)
-  })
+  const proxyReq = httpModule.request(options, (proxyRes) =>
+    handleProxyResponse(proxyRes, req, res, parsedUrl, redirectCount),
+  )
 
   proxyReq.on('error', (error) => {
     console.error('Proxy error:', error.message)
     if (!res.headersSent) {
       res.writeHead(500, { 'Content-Type': 'application/json' })
-      res.end(
-        JSON.stringify({
-          error: 'Proxy error',
-          message: error.message,
-        }),
-      )
+      res.end(JSON.stringify({ error: 'Proxy error', message: error.message }))
     }
   })
 
@@ -68,11 +120,7 @@ function makeProxyRequest(httpModule, parsedUrl, req, res) {
     proxyReq.destroy()
     if (!res.headersSent) {
       res.writeHead(504, { 'Content-Type': 'application/json' })
-      res.end(
-        JSON.stringify({
-          error: 'Gateway timeout',
-        }),
-      )
+      res.end(JSON.stringify({ error: 'Gateway timeout' }))
     }
   })