feat: support custom API and tailscale

Author: Fatpandac

README.md

@@ -4,7 +4,7 @@ Link **DocSearch** and **Meilisearch** into Raycast.
 
 ![interface](./metadata/docsearch-1.png)
 
-### Supported Documentations (52 documentations | 90 different versions)
+### Supported Documentations (53 documentations | 91 different versions)
 
 |               Documentations               |                                                   |                                                       |
 | :----------------------------------------: | :-----------------------------------------------: | :---------------------------------------------------: |
@@ -25,7 +25,7 @@ Link **DocSearch** and **Meilisearch** into Raycast.
 |   [MassTransit](https://masstransit.io/)   |         [Pinia](https://pinia.vuejs.org/)         |          [Yazi](https://yazi-rs.github.io/)           |
 |     [Ollama](https://docs.ollama.com/)     |           [Homarr](https://homarr.dev/)           |           [Rsdoctor](https://rsdoctor.rs/)            |
 |       [Rsbuild](https://rsbuild.rs/)       |           [Rspack](https://rspack.rs/)            |              [Rslib](https://rslib.rs/)               |
-|        [Rstest](https://rstest.rs/)        |
+|        [Rstest](https://rstest.rs/)        |        [Tailscale](https://tailscale.com/)        |
 
 ### Docsearch
 

assets/logo/tailscale.png

@@ -797,6 +797,21 @@
         }
       ],
       "mode": "view"
+    },
+    {
+      "name": "tailscale",
+      "icon": "/logo/tailscale.png",
+      "title": "Tailscale",
+      "subtitle": "DocSearch",
+      "description": "Search Tailscale documentation",
+      "arguments": [
+        {
+          "name": "search",
+          "placeholder": "Search...",
+          "type": "text"
+        }
+      ],
+      "mode": "view"
     }
   ],
   "dependencies": {

package.json

@@ -117,6 +117,8 @@ declare namespace Preferences {
   export type Rslib = ExtensionPreferences & {}
   /** Preferences accessible in the `rstest` command */
   export type Rstest = ExtensionPreferences & {}
+  /** Preferences accessible in the `tailscale` command */
+  export type Tailscale = ExtensionPreferences & {}
 }
 
 declare namespace Arguments {
@@ -379,6 +381,11 @@ declare namespace Arguments {
   export type Rstest = {
   /** Search... */
   "search": string
+}
+  /** Arguments passed to the `tailscale` command */
+  export type Tailscale = {
+  /** Search... */
+  "search": string
 }
 }
 

raycast-env.d.ts

@@ -1,6 +1,7 @@
 import { data } from "../../src/data/apis";
 import { DocID } from "../../src/data/types";
 import { checkAlgolia } from "./checkAlgolia";
+import { checkCustom } from "./checkCustom";
 import { checkMeilisearch } from "./checkMeilisearch";
 import { checkTrieve } from "./checkTrieve";
 
@@ -18,7 +19,6 @@ function main() {
       const docsName = DocID[parseInt(id)];
       let res = false;
 
-
       switch (api.type) {
         case "algolia": {
           res = await checkAlgolia(api);
@@ -32,6 +32,10 @@ function main() {
           res = await checkTrieve(api);
           break;
         }
+        case "custom": {
+          res = await checkCustom(api);
+          break;
+        }
         default: {
           const { type } = api;
           return type satisfies never;

scripts/test/checkApiAvailable.ts

@@ -0,0 +1,10 @@
+import { Custom } from "../../src/data/types";
+
+export async function checkCustom(api: Custom) {
+  try {
+    await api.request("");
+    return true;
+  } catch {
+    return false;
+  }
+}

scripts/test/checkCustom.ts

@@ -1,5 +1,5 @@
 import { data } from "../data/apis";
-import { useAlgolia, useMeilisearch, useTrieve } from "../hooks";
+import { useAlgolia, useMeilisearch, useSearch, useTrieve } from "../hooks";
 
 import { ActionPanel, List, Action, Icon } from "@raycast/api";
 import { useState, useMemo } from "react";
@@ -36,6 +36,12 @@ export function SearchDocumentation(props: { id: DocID; quickSearch?: string })
       searchResults = (currentAPI.formatter || trieveDefaultFormatter)(res.searchResults);
       break;
     }
+    case "custom": {
+      const res = useSearch(searchText, currentAPI);
+      isLoading = res.isLoading;
+      searchResults = res.searchResults;
+      break;
+    }
     default: {
       const { type } = currentAPI;
       return type satisfies never;

src/components/SearchDocumentation.tsx

@@ -9,6 +9,7 @@ import {
   supabase, tailwindcss, taro, tauri, vite, vitest, vueRouter,
   vue, vueUse, vuepress, typescript, nextjs, massTransit, raycast,
   unidata, pinia, homarr, rsdoctor, rsbuild, rspack, rslib, rstest,
+  tailscale
 } from "./docs";
 
 export const data: Data = {
@@ -64,4 +65,5 @@ export const data: Data = {
   [DocID.Rspack]: rspack,
   [DocID.Rslib]: rslib,
   [DocID.Rstest]: rstest,
+  [DocID.Tailscale]: tailscale,
 };

src/data/apis.ts

@@ -50,6 +50,7 @@ import rspack from "./rspack";
 import rslib from "./rslib";
 import rstest from "./rstest";
 import rsbuild from "./rsbuild";
+import tailscale from "./tailscale";
 
 // prettier-ignore
 export {
@@ -58,5 +59,5 @@ export {
   laravel, nuxt, nvchad, pnpm, clerk, prettier, raycast, react, reactBootstrap,
   reactNative, remix, slidev, supabase, tailwindcss, taro, tauri, vite, vitest,
   vueRouter, vue, vueUse, vuepress, typescript, nextjs, massTransit, pinia,
-  unidata, homarr, rsdoctor, rspack, rslib, rstest, rsbuild
+  unidata, homarr, rsdoctor, rspack, rslib, rstest, rsbuild, tailscale
 };

src/data/docs/index.ts

@@ -0,0 +1,36 @@
+import { DocItem } from "../types";
+import { FormatResultItem } from "../../utils";
+import { randomUUID } from "crypto";
+
+type TailscaleResponseItem = {
+  description: string;
+  permalink: string;
+  title: string;
+};
+
+type TailscaleResponse = {
+  data: Array<TailscaleResponseItem>;
+  status: string;
+};
+
+const tailscale: DocItem = {
+  "en-US": {
+    type: "custom",
+    icon: "../assets/logo/tailscale.png",
+    homepage: "https://tailscale.com/",
+    request: async (query: string) => {
+      const API_URL = `https://tailscale.com/api/search?q=${encodeURIComponent(query)}`;
+      const res = (await fetch(API_URL).then((response) => response.json())) as TailscaleResponse;
+      const formattedResults = res.data.map<FormatResultItem>((item) => ({
+        id: randomUUID(),
+        title: item.title,
+        content: item.description.replace(/<mark>/g, "**").replace(/<\/mark>/g, "**"),
+        url: item.permalink,
+      }));
+
+      return formattedResults;
+    },
+  },
+};
+
+export default tailscale;