Iframe-hurtigstart

Dette er den hurtigste måde at afprøve Developer API'en uden først at bygge en backend.

I iframe-tilstand kommunikerer din app med Chastify-forælderen via postMessage, og Chastify kalder server-API'er på dine vegne.

Hvad Chastify sender til din iframe

Ved åbning placerer Chastify en JSON-nyttelast i location.hash.
Vigtige felter:

• bridge.nonce: anmodning om signeringsværdi for bromeddelelser.
• bridge.parentOrigin: påkrævet måloprindelse for postMessage.
• sessionId: stabilt udvidelsessessions-id for denne lås.
• lockId: aktiv låse-id.
• ui: temaværdier fra overordnet side.
• Valgfrit: homeActionSlug, homeAction, intent, regularActionsSummary, mainToken.

Hurtig start med Bridge Library (anbefales)

Brug hjælpere fra 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 eksempel (ingen hjælpeklasse)

Hvis du ikke bruger ChastifyBridgeClient, skal du sende hele anmodningskuverten manuelt:

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

window.parent.postMessage(req, parentOrigin);

Lyt efter matchende 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);
});

Testflow, du bør køre først

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

Dette bekræfter brogodkendelse, sikker læsning og håndtering af anmodninger/svar. Tilstandsskrivninger skal udføres af din backend med Developer API-legitimationsoplysninger.

Filuploads fra iframe

Hvis din udvidelse har brug for billeder eller genererede medier, skal du bruge brofilhjælperne. Chastify uploader til administreret R2-lager, returnerer et stabilt fil-id og giver dig en kortvarig signeret URL til gengivelse.

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;
}

Gem uploaded.file.id, ikke den signerede URL. Signerede URL'er udløber og bør opdateres med files.get / client.filesGet(...), når iframen indlæses igen.

Tema-understøttelse (ui + themeVars)

Chastify sender et ui-objekt i iframe-hashen.
themeVars(ui) konverterer det til brugbare designtokens:

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

Brug disse værdier som din udvidelses basisstyling, så din iframe matcher værtstemaet.

Live-temaopdateringer

Forælderen kan sende chastify:ext:ui-hændelser, mens din iframe er åben.
Hvis du vil have synkronisering af live-temaer, skal du lytte efter den hændelse og opdatere den lokale tematilstand.

For detaljeret håndtering af lyse/mørke temaer, eksempler på kontrast og Tailwind-mønstre, se Iframe Theming.

Understøttelse af automatisk størrelsesændring

Brug startAutoResizeToParent(...), så den overordnede fil kan ændre størrelsen på iframen, så den passer til dit indhold.

Hvorfor dette er vigtigt:

• Forhindrer scroll traps inde i iframe'en.
• Holder opsætningsmodaler og udvidelsessider i korrekt størrelse.
• Fungerer godt til dynamiske sektioner, der udvides/skjules.

Almindelige fejl

• Forkert targetOrigin (skal matche bridge.parentOrigin).
• Manglende eller forældet nonce.
• Kalder ikke destroy() ved afmontering af ChastifyBridgeClient.
• Sender ikke-understøttede handlinger uden først at kontrollere session.get-funktionerne.

Referencefiler

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