Convex changelog

Overview

Release notes for @shipdit/convex, newest first. Upgrade steps for breaking releases are in Migration guides.

ConvexBreaking

Unreleased

Breaking changes

SHIPD_EDGE_URL was removed. The component fetches snapshots from https://edge.useshipd.com. Remove SHIPD_EDGE_URL from defineApp and from the env you pass to app.use(shipd, …). TypeScript reports the leftover key as an unknown property.

// Before
app.use(shipd, {
  name: "shipd",
  httpPrefix: "/shipd",
  env: {
    SHIPD_SDK_KEY: app.env.SHIPD_SDK_KEY,
    SHIPD_EDGE_URL: app.env.SHIPD_EDGE_URL,
    SHIPD_WEBHOOK_SECRET: app.env.SHIPD_WEBHOOK_SECRET,
  },
});

// After
app.use(shipd, {
  name: "shipd",
  httpPrefix: "/shipd",
  env: {
    SHIPD_SDK_KEY: app.env.SHIPD_SDK_KEY,
    SHIPD_WEBHOOK_SECRET: app.env.SHIPD_WEBHOOK_SECRET,
  },
});

Timestamp comparisons now require valid dates and explicit timezones. Ordered comparisons (gt, gte, lt, lte) follow one grammar shared with the Go SDK: YYYY-MM-DD (midnight UTC), or a date-time with a required Z or ±hh:mm zone. Zone-less date-times, lenient formats such as 2026-01-02 10:00, and impossible dates such as 2026-02-30 now compare as strings instead of through Date.parse, so results no longer depend on the server’s timezone. See How values compare.Dashboard preview uses this grammar as soon as the dashboard deploys; production changes only when you upgrade the SDK or Convex component. The edge serves snapshots and does not evaluate rules. Review date-based rules before upgrading; older SDKs can disagree with preview.

Added

Optional SHIPD_UNSAFE_EDGE_URL replaces the edge origin. It is unsafe and meant for shipd development and test environments only, because that URL receives your SDK key. Invalid values fail each refresh with a clear lastError, and a plaintext URL to a non-local host logs a warning.

Changed

The X-Shipd-SDK-Version header now reports convex-<installed package version> instead of the fixed convex-0.1.0.

See Upgrade the Convex component to 0.2.

​Overview

​Breaking changes

​Added

​Changed

Overview

Breaking changes

Added

Changed