Aller au contenu
OpenChamber
↑↓Naviguer ↵Ouvrir escFermer

Exemple

Ces trois fichiers forment une extension fonctionnelle. Elle connecte un token GitHub, liste vos dépôts et vous permet d’en attacher un au chat. Copiez-les dans un dossier, puis changez l’API et la liste pour votre propre fournisseur. Pour les champs du manifeste et l’installation, voir Créer une extension ; pour chaque méthode, voir API hôte.

package.json :

{
  "name": "my-repos",
  "version": "1.0.0",
  "private": true,
  "openchamber": {
    "apiVersion": 1,
    "contributes": {
      "panel": { "id": "my-repos", "name": "Repos", "icon": "github", "entry": "panel/index.html" },
      "attach": "panel",
      "integration": {
        "name": "GitHub (token)",
        "description": "Lists your repositories.",
        "token": {
          "apiOrigin": "https://api.github.com",
          "account": { "path": "/user", "name": "login" },
          "scheme": "bearer"
        }
      }
    }
  },
  "dependencies": { "@openchamber/sdk": "^1.24.0" }
}

panel/index.html :

<!doctype html>
<html>
  <head>
    <meta charset="utf-8" />
    <style>html, body { margin: 0; height: 100%; } #root { height: 100%; padding: 12px; box-sizing: border-box; }</style>
  </head>
  <body>
    <div id="root"></div>
    <script src="main.js"></script>
  </body>
</html>

panel/main.ts :

import { connectHost, HostRequestError } from "@openchamber/sdk";
import { applyHostReady, mountBanner, mountEmpty, mountList, mountSpinner } from "@openchamber/sdk/ui";


type Repo = { full_name: string; html_url: string; description: string | null };


const host = connectHost();
const root = document.querySelector("#root")!;
let mounted: Array<{ dispose: () => void }> = [];


const clear = () => {
  for (const block of mounted) block.dispose();
  mounted = [];
};


let generation = 0;
const paint = async (connected: boolean) => {
  const currentGeneration = ++generation;
  clear();
  if (!connected) {
    mounted.push(mountEmpty(root, {
      title: "Not connected",
      body: "Paste a GitHub token in Settings → Integrations → GitHub (token).",
    }));
    return;
  }
  const spinner = mountSpinner(root, { label: "Loading repositories" });
  mounted.push(spinner);
  try {
    const result = await host.request({ method: "GET", path: "/user/repos", query: { per_page: "30", sort: "updated" } });
    if (currentGeneration !== generation) return;
    spinner.dispose();
    if (result.status !== 200) {
      mounted.push(mountBanner(root, { tone: "error", title: `GitHub answered ${result.status}` }));
      return;
    }
    const repos = JSON.parse(result.body) as Repo[];
    mounted.push(mountList(root, {
      items: repos.map((repo) => ({ id: repo.full_name, title: repo.full_name, subtitle: repo.description ?? undefined })),
      onSelect: (id) => {
        const repo = repos.find((item) => item.full_name === id);
        if (repo) void host.attach({ providerId: "my-repos", id: repo.full_name, title: repo.full_name, url: repo.html_url });
      },
    }));
  } catch (error) {
    if (currentGeneration !== generation) return;
    spinner.dispose();
    const text = error instanceof HostRequestError ? `${error.code}: ${error.message}` : String(error);
    mounted.push(mountBanner(root, { tone: "error", title: "Request failed", body: text }));
  }
};


host.onReady((ctx) => {
  applyHostReady(ctx, document.documentElement);
});
let previousConnection: string | undefined;
host.onConnection((connection) => {
  const key = JSON.stringify(connection);
  if (key === previousConnection) return;
  previousConnection = key;
  void paint(connection.connected);
});

Pour installer et mettre à jour par URL Git, commitez panel/main.js compilé avec le HTML et le manifeste. OpenChamber n’installe pas les dépendances npm et ne compile pas TypeScript à l’installation. Versionnez le lockfile, ajoutez node_modules/ à .gitignore et incluez les dépendances navigateur dans l’IIFE. Pour une mise à jour, augmentez la version propre de l’extension dans package.json, recompilez, commitez et poussez. Choisissez Update dans Settings → Extensions. Une URL fixée à un tag Git reste sur ce tag.

Construisez-la depuis le dossier avec bunx openchamber-guest-bundle panel/main.ts panel/main.js, puis ajoutez le dossier dans Paramètres → Extensions. Cinq autres exemples (chaque composant UI, une liste de tâches avec des actions et une commande slash, un service local, un éditeur de fichier de configuration, un package uniquement composé d’outils) se trouvent sur github.com/openchamber/openchamber/tree/main/packages/sdk/examples.