Quickstart

npm install @heretic-hq/collector

import { heretic } from '@heretic-hq/collector';

const result = await heretic({
  siteKey: 'hrtc_live_0123456789abcdef01234567',
});

if (!result.ok || !result.requestId) {
  console.warn('Heretic collection did not complete', result.reason);
} else {
  await fetch('/api/heretic-request', {
    method: 'POST',
    headers: { 'content-type': 'application/json' },
    body: JSON.stringify({ requestId: result.requestId }),
  });
}

type HereticResult = {
  ok: boolean;
  requestId?: string | null;
  reason?: string;
};

const VERDICT_ORIGIN = 'https://heretic.quest';

export async function readHereticVerdict(requestId) {
  const response = await fetch(
    `${VERDICT_ORIGIN}/v1/verdict/${encodeURIComponent(requestId)}`,
    {
      headers: {
        authorization: `Bearer ${process.env.HERETIC_VERDICT_KEY}`,
      },
    },
  );

  if (response.status === 200) {
    return { state: 'available', value: await response.json() };
  }

  if (response.status === 404) {
    return { state: 'unavailable' };
  }

  if (response.status === 401) {
    throw new Error(
      'Heretic verdict key is missing, malformed, unknown, or revoked',
    );
  }

  throw new Error(`Heretic verdict read failed with HTTP ${response.status}`);
}

HERETIC_VERDICT_KEY=hrtc_sk_0123456789abcdef0123456789abcdef

const read = await readHereticVerdict(requestId);

if (read.state === 'available') {
  const { verdict, conclusive, families, provenance } = read.value;
  console.log({ verdict, conclusive, families, provenance });
}