@trymeai/sdk-types

The public TypeScript types for the TryMeAI SDK — the partner-facing surface of window.TryMeAIMini, i.e. the handle that @trymeai/sdk's loadTryMeAI() resolves to. Zero runtime (types only).

npm install -D @trymeai/sdk-types

What it exports

• TryMeAIMini — the minimal partner-facing handle interface (init · tryOn · openTryOnModal · getSession · subscribeToSession · ensureSession · refreshIdentity · findMySize · destroy).

• The public data types: TryMeAIInitConfig, TryOnParams, PartnerSessionToken, SdkPublicSession, SessionState, StartSessionOptions, FindMySizeResult, UserType (plus the shapes they reference).

• Add to cart (SDK 1.4.0+): AddToCartEventPayload — the trymeai:addToCart detail, including the variant-card fields variantId, salePrice, currency, market, availability, offerUpdatedAt, offerSource and pdpUrl, all optional and present only on an add from the variant card — plus AddToCartAck and AddToCartAckResult for answering one.

  The answer is expected within 1.5 s, via detail.ack({ ok }) on the event or the ack argument of TryMeAIInitConfig.onAddToCart, which is called for every add alongside (never instead of) the window event. Without an answer the card shows "Couldn't add — please try again".

Single source of truth

Every type here is re-exported from the SDK core's real src/core/types.ts — never hand-copied. The one authored declaration, the TryMeAIMini interface, is drift-guarded: the core build contains a compile-time check that the concrete TryMeAIMiniSdk instance satisfies this interface, so a public method that is renamed, removed, or whose signature drifts fails the core's tsc — the published types can't silently diverge from the implementation.

@trymeai/sdk re-exports these types, so app code usually imports from @trymeai/sdk directly and never needs to depend on this package explicitly.