Migration notes
Move deprecated Apex SDK init aliases to the current InitConfig fields.
The SDK still accepts legacy aliases for backward compatibility, but new code should use the current fields.
Deprecated aliases
| Deprecated field | Current field | Compatibility behavior |
|---|---|---|
deferTracking | trackingStart | true maps to "idle"; false maps to "immediate". |
antiFlicker | antiFlickerMode | true maps to "full"; false maps to "off". |
antiFlickerTimeout | antiFlickerTimeoutMs | Number is used as the anti-flicker timeout. |
Before
ts
import { init } from "@drip-apex/sdk";
init({
shopId: "demo-shop",
endpoint: "https://events.drip-apex.com",
deferTracking: true,
antiFlicker: true,
antiFlickerTimeout: 1500
});After
ts
import { init } from "@drip-apex/sdk";
init({
shopId: "demo-shop",
endpoint: "https://events.drip-apex.com",
trackingStart: "idle",
antiFlickerMode: "full",
antiFlickerTimeoutMs: 1500
});For most production installs, prefer antiFlickerMode: "scoped" over the legacy full-page hide behavior.
Config fetch naming
Use endpoint, not workerUrl, in SDK examples. The SDK normalizes the base endpoint and appends the correct path for /config, /events, /v1/handover/mint, and order identity calls.