Typescript SDK introduced breaking changes in v0.41.5 -> v0.42.0 on `polar.events.list()`

[dugjason]

Description (tl;dr)

In the change from v0.41.5 -> v0.42.0, the polar.events.list() method return signature changed from an iterator to a simple {items, pagination} object (no iterator)
polarsource/polar-js@6aa520c#diff-b195183c950774c1c79f0215a1ac47bd06feb24491df8dc5770c31d22a627391

What is the expected behaviour?

I would not expect a breaking change in a minor SDK version update

What errors or issues are you experiencing?

No response

How can it be reproduced?

Load up the following code in your IDE on versions v0.41.* vs v0.42.*

      const iterator = await polar.events.list({
        externalCustomerId,
        name,
        startTimestamp,
        endTimestamp,
        limit,
        sorting: ["-timestamp"],
      })
      const events: PolarEvent[] = []
      for await (const page of iterator) {
        events.push(...page.result.items)
      }

✅ v0.41.* is OK
❌ v0.42.* shows missing async iterator error;

Which adapter(s) does this relate to?

• Next.js
• BetterAuth
• Nuxt
• Remix
• TanStack Start
• SvelteKit
• Supabase
• Astro
• Deno
• Elysia
• Express
• Fastify
• Hono
• Others (please specify in the description)

What environment are you running it in?

Local IDE + Vercel build env

[pieterbeulque]

Just as an FYI, from the semver spec.

Major version zero (0.y.z) is for initial development. Anything may change at any time. The public API should not be considered stable.

As much as possible, we try to keep patch range changes non-breaking but can introduce new or breaking API's on the 0.y minor range.

That said, I'm curious what changed on our end that caused this to change in the SDK.