TypeScript SDK changelog

​

Breaking changes

• shipdit: `endpoint` was removed…
• shipdit: `streamEndpoint` was removed…

// Before
createClient<FlagDefinitions>({
  sdkKey: process.env.SHIPD_SDK_KEY!,
  endpoint: "https://edge.useshipd.com",
  streamEndpoint: "https://ws.useshipd.com",
});

// After
createClient<FlagDefinitions>({
  sdkKey: process.env.SHIPD_SDK_KEY!,
  stream: true,
});

// Before: later evaluations on this client used usr_8f2k19
shipd.identify({ userId: "usr_8f2k19", traits: { plan: "pro" } });
shipd.isEnabled("new-checkout");

// After: pass the user to each evaluation
shipd.identify({ userId: "usr_8f2k19", traits: { plan: "pro" } }); // event only
shipd.isEnabled("new-checkout", { userId: "usr_8f2k19", attributes: { plan: "pro" } });

​

Added

• stream option (default false) enables realtime updates with a WebSocket implementation. Node.js 20 callers supply the WebSocket option; Node.js 22+ provides one globally.
• overrides.streamEndpoint replaces the WebSocket gateway used when stream is true.
• overrides.unsafeEndpoint replaces the edge origin. It is unsafe and meant for shipd development and test environments only, because that URL receives your SDK key.
• close() returns a promise that resolves after pending events are delivered, delivery fails, or the timeout passes. It includes events recorded during an in-flight send. It never rejects. close({ timeoutMs }) bounds the wait (default 5 seconds) and then aborts pending sends.

await shipd.close();

​

Changed

• Evaluation events from server clients carry the userId of the context passed to each evaluation.
• Event batches are capped at 100 events per request, the edge’s limit, so a backlog after an outage is delivered instead of rejected.
• overrides.unsafeEndpoint and overrides.streamEndpoint must be absolute URLs without credentials, a query, or a fragment; createClient throws otherwise and warns when an SDK key would be sent in plaintext to a non-local host.