Snabbstart för iframe

Detta är det snabbaste sättet att testa Developer API:et utan att först bygga en backend.

I iframe-läge kommunicerar din app med Chastify-föräldern via postMessage, och Chastify anropar server-API:er åt dig.

Vad Chastify skickar till din iframe

Vid öppning placerar Chastify en JSON-nyttolast i location.hash.
Viktiga fält:

• bridge.nonce: begäran om signeringsvärde för bryggmeddelanden.
• bridge.parentOrigin: obligatoriskt målursprung för postMessage.
• sessionId: stabilt tilläggssessions-ID för detta lås.
• lockId: aktivt lås-ID.
• ui: temavärden från överordnad sida.
• Valfritt: homeActionSlug, homeAction, intent, regularActionsSummary, mainToken.

Snabbstart med Bridge Library (rekommenderas)

Använd hjälpfiler från apps/extension/src/lib/ChastifyBridge.ts:

• parseHashPayload()
• ChastifyBridgeClient
• startAutoResizeToParent(...)
• themeVars(...)

Minimal React-bootstrap

import { useEffect, useMemo, useState } from "react";
import {
  parseHashPayload,
  ChastifyBridgeClient,
  startAutoResizeToParent,
  themeVars,
} from "../lib/ChastifyBridge";

const payload = parseHashPayload();
if (!payload?.bridge?.nonce || !payload?.bridge?.parentOrigin) {
  throw new Error("Missing bridge payload in iframe hash");
}

export function App() {
  const [client, setClient] = useState<ChastifyBridgeClient | null>(null);
  const [session, setSession] = useState<any>(null);
  const [stateDoc, setStateDoc] = useState<any>(null);
  const vars = useMemo(() => themeVars(payload.ui ?? null), []);

  useEffect(() => {
    const c = new ChastifyBridgeClient({
      nonce: payload.bridge!.nonce,
      targetOrigin: payload.bridge!.parentOrigin,
    });
    setClient(c);
    return () => c.destroy();
  }, []);

  useEffect(() => {
    if (!client) return;
    (async () => {
      const s = await client.request("session.get", {});
      setSession(s);

      const st = await client.request("state.get", {});
      setStateDoc(st);
    })().catch(console.error);
  }, [client]);

  useEffect(() => {
    return startAutoResizeToParent({
      nonce: payload.bridge!.nonce,
      targetOrigin: payload.bridge!.parentOrigin,
      extraPx: 12,
    });
  }, []);

  return (
    <div style={{ background: vars.pageBg, color: vars.text, minHeight: "100%" }}>
      <h2>Extension Quickstart</h2>
      <pre>{JSON.stringify(session, null, 2)}</pre>
      <pre>{JSON.stringify(stateDoc, null, 2)}</pre>
    </div>
  );
}

Rå postMessage-exempel (ingen hjälpklass)

Om du inte använder ChastifyBridgeClient, skicka hela förfrågningskuvertet manuellt:

const req = {
  type: "chastify:ext:req",
  v: 1,
  id: crypto.randomUUID(),
  nonce,
  action: "session.get",
  payload: {},
};

window.parent.postMessage(req, parentOrigin);

Lyssna efter matchande svar:

window.addEventListener("message", (event) => {
  if (event.origin !== parentOrigin) return;
  const msg = event.data;
  if (!msg || msg.type !== "chastify:ext:resp" || msg.v !== 1) return;
  if (msg.id !== req.id) return;

  if (msg.ok) console.log("Bridge success:", msg.data);
  else console.error("Bridge error:", msg.error);
});

Testflöde du bör köra först

1. session.get
2. state.get
3. metadata.get
4. regularActions.get

Detta bekräftar bryggautentisering, säkra läsningar och hantering av förfrågningar/svar. Tillståndsskrivningar måste utföras av din backend med Developer API-inloggningsuppgifter.

Filuppladdningar från iframe

Om ditt tillägg behöver bilder eller genererade media, använd bryggfilshjälparna. Chastify laddar upp till hanterad R2-lagring, returnerar ett stabilt fil-ID och ger dig en kortlivad signerad URL för rendering.

const capabilities = await client.filesCapabilities();
if (capabilities.enabled) {
  const uploaded = await client.filesUpload({
    file,
    filename: file.name,
    purpose: "puzzle-image",
  });

  // Send uploaded.file.id to your backend if it should be stored in session state.

  const refreshed = await client.filesGet(uploaded.file.id);
  image.src = refreshed.file.signedUrl;
}

Lagra uploaded.file.id, inte den signerade URL:en. Signerade URL:er upphör att gälla och bör uppdateras med files.get / client.filesGet(...) när iframe-filen laddas igen.

Temasupport (ui + themeVars)

Chastify skickar ett ui-objekt i iframe-hashen.
themeVars(ui) konverterar det till användbara designtokens:

• pageBg
• text
• panel
• border
• muted
• inputBg

Använd dessa värden som din tilläggs basformatering så att din iframe matchar värdtemat.

Live-temauppdateringar

Föräldern kan skicka chastify:ext:ui-händelser medan din iframe är öppen.
Om du vill ha synkronisering av live-tema, lyssna efter den händelsen och uppdatera det lokala temats tillstånd.

För detaljerad hantering av ljusa/mörka teman, kontrastexempel och Tailwind-mönster, se Iframe-teman.

Stöd för automatisk storleksändring

Använd startAutoResizeToParent(...) så att föräldern kan ändra storlek på iframe-filen efter ditt innehåll.

Varför detta är viktigt:

• Förhindrar scroll traps inuti iframe-rutan.
• Håller installationsmodaler och tilläggssidor i korrekt storlek.
• Fungerar bra för dynamiska sektioner som expanderar/minskars.

Vanliga misstag

• Fel targetOrigin (måste matcha bridge.parentOrigin).
• nonce saknas eller är inaktuell.
• Anropar inte destroy() vid avmontering för ChastifyBridgeClient.
• Skickar åtgärder som inte stöds utan att först kontrollera session.get-funktionerna.

Referensfiler

• apps/extension/src/lib/ChastifyBridge.ts
• apps/extension/src/pages/MainPage.tsx
• apps/extension/src/pages/SetupPage.tsx