@adaptif/client
v0.1.0
Published
Experimental headless browser runtime for Adaptif. React apps should use @adaptif/react.
Downloads
371
Maintainers
Readme
@adaptif/client
Experimental headless browser runtime for Adaptif. @adaptif/react is the supported way to render decisions. Use this package when the application is not React, or when Adaptif should drive side effects instead of JSX.
The API can change in any 0.x release.
npm install @adaptif/core @adaptif/clientimport { defineAdaptif } from "@adaptif/core";
import { createAdaptifClient } from "@adaptif/client";
const config = defineAdaptif<{ currentPage: string }>()({
situations: {
"The user is unaware of the copilot": { id: "unawareOfCopilot" },
},
goals: ["copilot_draft_started"],
events: ["brief_section_revised"],
});
const adaptif = createAdaptifClient(config, {
endpoint: "/api/adaptif",
});
adaptif.setState({ currentPage: location.pathname });
const unsubscribe = adaptif.when("unawareOfCopilot", (decision, exposure) => {
if (!decision.active) return;
// Calling the listener does not count as a display.
// Record an exposure when the app handles the decision, including the
// holdout arm, where it keeps the normal UI.
exposure.recordExposure();
});
adaptif.emit("brief_section_revised", "tradeoffs");
adaptif.track("copilot_draft_started");
unsubscribe();
adaptif.destroy();when, match, and gauge are typed from adaptif.config.ts. An unknown question throws. Timeouts, errors, and a false onlyIf leave the decision inactive (active: false, value: null, or level: null). The client starts automatically. With autostart: false, subscriptions stay inactive until start() is called. destroy() is terminal and prevents later subscriptions or outcome recording.
React is the better fit when a decision should choose JSX, when cleanup and re-rendering should be automatic, or when holdouts should record exposures from what actually rendered. <When> and useSituation stay the supported rendering API and are implemented on this runtime.
React apps install @adaptif/react, which depends on this package. A server route still comes from @adaptif/server.
@adaptif/client/internal is the adapter surface @adaptif/react builds on. It isn't a supported import for applications and can change in any release.
