@tscircuit/fake-snippets 0.0.88 → 0.0.90

package/api/generated-index.js

@@ -4,14 +4,57 @@ import { readFileSync } from "fs"
 import { join, dirname } from "path"
 import { fileURLToPath } from "url"
 import he from "he"
-
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = dirname(__filename)
 
-const normalIndexFile = join(__dirname, "../dist/index.html")
-const htmlContent = readFileSync(normalIndexFile, "utf-8")
+const isDev =
+  process.env.TSC_DEV_SSR === "true" || process.env.NODE_ENV === "development"
+const normalIndexFile = isDev
+  ? join(__dirname, "../index.html")
+  : join(__dirname, "../dist/index.html")
+let htmlContent = readFileSync(normalIndexFile, "utf-8")
+
+export function setHtmlContent(html) {
+  htmlContent = html
+}
 
-const cacheControlHeader = "public, max-age=0, must-revalidate"
+const BASE_URL = process.env.TSC_BASE_URL || "https://tscircuit.com"
+const REGISTRY_URL = process.env.TSC_REGISTRY_API || "https://api.tscircuit.com"
+
+export const cacheControlHeader = "public, max-age=0, must-revalidate"
+const PREFETCHABLE_PAGES = new Set([
+  "landing",
+  "editor",
+  "search",
+  "trending",
+  "dashboard",
+  "latest",
+  "settings",
+  "quickstart",
+])
+
+const pageDescriptions = {
+  landing:
+    "Build electronics with code, AI, and drag'n'drop tools. Render code into schematics, PCBs, 3D, fabrication files, and more. Open-source MIT licensed electronic design automation tool.",
+  dashboard:
+    "Your tscircuit dashboard - manage your electronic circuit packages, view trending and latest packages, and access your recent designs.",
+  search:
+    "Search and discover electronic circuit packages on tscircuit. Find components, circuits, and designs created by the community.",
+  editor:
+    "Design and edit electronic circuits online with tscircuit's powerful web-based editor. Create schematics, PCB layouts, and 3D models with code.",
+  trending:
+    "Discover the most popular and trending electronic circuit packages on tscircuit. Find top-rated components, keyboards, microcontrollers, connectors, and sensors.",
+  latest:
+    "Explore the newest electronic circuit packages on tscircuit. Discover fresh circuit designs, components, and innovative approaches to electronic design.",
+  quickstart:
+    "Get started quickly with tscircuit. Create new circuit packages, import components from JLCPCB, or start from templates to begin your electronic design journey.",
+  settings:
+    "Manage your tscircuit account settings, shipping information, and preferences for electronic design and PCB ordering.",
+}
+
+function getPageDescription(pageName) {
+  return pageDescriptions[pageName] || ""
+}
 
 function getHtmlWithModifiedSeoTags({
   title,
@@ -86,6 +129,30 @@ function getHtmlWithModifiedSeoTags({
   return modifiedHtml
 }
 
+export async function handleUserProfile(req, res) {
+  const username = req.url.split("/")[req.url.split("/").length - 1]
+
+  if (!username) {
+    throw new Error("Username not provided")
+  }
+
+  const description = he.encode(`Circuits created by ${username} on tscircuit`)
+
+  const title = he.encode(`${username} - tscircuit`)
+
+  const html = getHtmlWithModifiedSeoTags({
+    title,
+    description,
+    canonicalUrl: `${BASE_URL}/${he.encode(username)}`,
+    imageUrl: `https://github.com/${username}.png`,
+  })
+
+  res.setHeader("Content-Type", "text/html; charset=utf-8")
+  res.setHeader("Cache-Control", cacheControlHeader)
+  res.setHeader("Vary", "Accept-Encoding")
+  res.status(200).send(html)
+}
+
 async function handleCustomPackageHtml(req, res) {
   // Get the author and package name
   const [_, author, unscopedPackageName] = req.url.split("?")[0].split("/")
@@ -94,7 +161,7 @@ async function handleCustomPackageHtml(req, res) {
   }
 
   const { package: packageInfo } = await ky
-    .get(`https://registry-api.tscircuit.com/packages/get`, {
+    .get(`${REGISTRY_URL}/packages/get`, {
       searchParams: {
         name: `${author}/${unscopedPackageName}`,
       },
@@ -109,7 +176,7 @@ async function handleCustomPackageHtml(req, res) {
   let packageFiles = null
   try {
     const releaseResponse = await ky
-      .post(`https://registry-api.tscircuit.com/package_releases/get`, {
+      .post(`${REGISTRY_URL}/package_releases/get`, {
         json: {
           package_id: packageInfo.package_id,
           is_latest: true,
@@ -122,7 +189,7 @@ async function handleCustomPackageHtml(req, res) {
     if (packageRelease?.package_release_id) {
       try {
         const filesResponse = await ky
-          .post(`https://registry-api.tscircuit.com/package_files/list`, {
+          .post(`${REGISTRY_URL}/package_files/list`, {
             json: {
               package_release_id: packageRelease.package_release_id,
             },
@@ -142,11 +209,16 @@ async function handleCustomPackageHtml(req, res) {
   )
   const title = he.encode(`${packageInfo.name} - tscircuit`)
 
+  const allowedViews = ["schematic", "pcb", "assembly", "3d"]
+  const defaultView = packageInfo.default_view || "pcb"
+  const thumbnailView = allowedViews.includes(defaultView) ? defaultView : "pcb"
+  const imageUrl = `${REGISTRY_URL}/packages/images/${he.encode(author)}/${he.encode(unscopedPackageName)}/${thumbnailView}.png?fs_sha=${packageInfo.latest_package_release_fs_sha}`
+
   const html = getHtmlWithModifiedSeoTags({
     title,
     description,
-    canonicalUrl: `https://tscircuit.com/${he.encode(author)}/${he.encode(unscopedPackageName)}`,
-    imageUrl: `https://registry-api.tscircuit.com/snippets/images/${he.encode(author)}/${he.encode(unscopedPackageName)}/pcb.png`,
+    canonicalUrl: `${BASE_URL}/${he.encode(author)}/${he.encode(unscopedPackageName)}`,
+    imageUrl,
     ssrPackageData: { package: packageInfo, packageRelease, packageFiles },
   })
 
@@ -164,17 +236,20 @@ async function handleCustomPage(req, res) {
     throw new Error("Use landing.html content")
   }
 
-  // TODO handle usernames
+  if (!PREFETCHABLE_PAGES.has(page)) {
+    throw new Error("Not a route that can be prefetched")
+  }
+
+  const pageDescription = getPageDescription(page)
 
   const html = getHtmlWithModifiedSeoTags({
-    title: `${page} - tscircuit`,
-    description: ``,
-    canonicalUrl: `https://tscircuit.com/${page}`,
+    title: `${page.charAt(0).toUpperCase() + page.slice(1)} - tscircuit`,
+    description: pageDescription,
+    canonicalUrl: `${BASE_URL}/${page}`,
   })
 
   res.setHeader("Content-Type", "text/html; charset=utf-8")
   res.setHeader("Cache-Control", cacheControlHeader)
-  // Add ETag support for better caching
   res.setHeader("Vary", "Accept-Encoding")
   res.status(200).send(html)
 }
@@ -194,6 +269,13 @@ export default async function handler(req, res) {
     console.warn(e)
   }
 
+  try {
+    await handleUserProfile(req, res)
+    return
+  } catch (e) {
+    console.warn(e)
+  }
+
   res.setHeader("Content-Type", "text/html; charset=utf-8")
   res.setHeader("Cache-Control", cacheControlHeader)
   // Add ETag support for better caching

package/bun-tests/fake-snippets-api/routes/proxy.test.ts

@@ -0,0 +1,42 @@
+import { test, expect } from "bun:test"
+import { getTestServer } from "bun-tests/fake-snippets-api/fixtures/get-test-server"
+
+test("should require X-Target-Url header", async () => {
+  const { axios } = await getTestServer()
+  try {
+    await axios.get("/api/proxy")
+    throw new Error("Should not reach here")
+  } catch (error: any) {
+    expect(error.status).toBe(400)
+    expect(error.data.error).toBe("X-Target-Url header is required")
+  }
+})
+
+test("should prevent recursive proxy calls when X-proxied header is present", async () => {
+  const { jane_axios: axios } = await getTestServer()
+  const port = axios.defaults?.baseURL?.split(":")[2]
+
+  try {
+    await axios.get("/api/proxy", {
+      headers: {
+        "X-Target-Url": `http://localhost:${port}/api/proxy`,
+      },
+    })
+    throw new Error("Should not reach here")
+  } catch (error: any) {
+    expect(error.status).toBe(403)
+    expect(error.data.error).toBe("Recursive proxy calls are not allowed")
+  }
+})
+
+test("should successfully proxy requests to allowed domains", async () => {
+  const { jane_axios: axios } = await getTestServer()
+  const port = axios.defaults?.baseURL?.split(":")[2]
+  const response = await axios.get("/api/proxy", {
+    headers: {
+      "X-Target-Url": `http://localhost:${port}/api/health`,
+    },
+  })
+
+  expect(response.status).toBe(200)
+})