Snel aan de slag met plugins

Met deze handleiding ga je snel van een lege map naar een werkende plugin.

1) Maak een minimale plugin met alleen een backend

Maak een map met deze bestanden:

my-plugin/
  manifest.json
  backend/
    script.js

manifest.json:

{
  "id": "my-plugin",
  "name": "My Plugin",
  "version": "0.1.0",
  "plugins": [
    {
      "kind": "backend",
      "id": "my-plugin-backend",
      "entrypoint": "backend/script.js"
    }
  ]
}

backend/script.js:

async function init(sdk) {
  sdk.console.log("Plugin started");

  sdk.events.onInterceptResponse(function(req, res) {
    if (!res) return;
    if (res.getCode() === 403) {
      sdk.console.warn("403 on " + req.getUrl());
    }
  });
}

Installeer via Plug-ins > Installeren, kies de map, schakel de plugin in en controleer of de logs Plugin started tonen.

2) Als je TypeScript gebruikt

Gebruik deze structuur:

my-plugin/
  manifest.json
  backend/
    src/index.ts

Bundel met:

pnpm add -D @ogmabox/ogma-sdk esbuild typescript
pnpm exec esbuild backend/src/index.ts \
  --bundle \
  --platform=neutral \
  --format=iife \
  --external:@ogma/sdk --external:@ogmabox/ogma-sdk \
  --outfile=backend/script.js

Installeer de map vervolgens zoals hierboven beschreven.

3) Voeg later een frontend toe

Voeg alleen een frontendvermelding en interfacebestanden toe wanneer je een paneel nodig hebt:

my-plugin/
  frontend/
    script.js
    style.css   # optional

Breid vervolgens manifest.json uit met:

{
  "kind": "frontend",
  "id": "my-plugin-frontend",
  "entrypoint": "frontend/script.js",
  "backend": { "id": "my-plugin-backend" }
}

Gebruik voor frontendcommunicatie window.ogmaSDK.ready(...) en houd backendaanroepen in sdk.api-handlers.

4) Machtigingen die je bijna altijd nodig hebt

Voor het backendvoorbeeld hierboven:

• geen (veilige standaardmachtigingen worden automatisch verleend)

Als je plugin uitgaande verzoeken verstuurt, voeg dan het volgende toe:

"permissions": ["send_requests"]

Als je plugin bevindingen schrijft, voeg dan het volgende toe:

"permissions": ["write_findings"]

Vraag alleen aan wat je daadwerkelijk gebruikt.

Problemen met je eerste plugin oplossen

• Plugin failed to initialize → open Logboeken en controleer of init(sdk) is gedefinieerd.
• Invalid manifest → controleer de komma's en aanhalingstekens in de JSON.
• Er worden geen callbacks uitgevoerd → controleer of de plugin is ingeschakeld en of de bijbehorende gebeurtenis (onInterceptResponse) is geregistreerd.

Voor de volledige API-naslagwerken:

• Pluginsysteem
• Backend-SDK
• Frontend-SDK