@polar-sh/sdk 0.17.0 → 0.17.2

package/src/funcs/usersOrdersList.ts

@@ -51,7 +51,8 @@ export async function usersOrdersList(
       | RequestAbortedError
       | RequestTimeoutError
       | ConnectionError
-    >
+    >,
+    { page: number }
   >
 > {
   const parsed = safeParse(
@@ -151,39 +152,42 @@ export async function usersOrdersList(
 
   const nextFunc = (
     responseData: unknown,
-  ): Paginator<
-    Result<
-      operations.UsersOrdersListResponse,
-      | errors.HTTPValidationError
-      | SDKError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | ConnectionError
-    >
-  > => {
+  ): {
+    next: Paginator<
+      Result<
+        operations.UsersOrdersListResponse,
+        | errors.HTTPValidationError
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+      >
+    >;
+    "~next"?: { page: number };
+  } => {
     const page = request?.page || 0;
     const nextPage = page + 1;
     const numPages = dlv(responseData, "pagination.max_page");
     if (numPages == null || numPages <= page) {
-      return () => null;
+      return { next: () => null };
     }
 
     if (!responseData) {
-      return () => null;
+      return { next: () => null };
     }
     const results = dlv(responseData, "items");
     if (!Array.isArray(results) || !results.length) {
-      return () => null;
+      return { next: () => null };
     }
     const limit = request?.limit || 0;
     if (results.length < limit) {
-      return () => null;
+      return { next: () => null };
     }
 
-    return () =>
+    const nextVal = () =>
       usersOrdersList(
         client,
         {
@@ -192,8 +196,10 @@ export async function usersOrdersList(
         },
         options,
       );
+
+    return { next: nextVal, "~next": { page: nextPage } };
   };
 
-  const page = { ...result, next: nextFunc(raw) };
+  const page = { ...result, ...nextFunc(raw) };
   return { ...page, ...createPageIterator(page, (v) => !v.ok) };
 }

package/src/funcs/usersSubscriptionsList.ts

@@ -51,7 +51,8 @@ export async function usersSubscriptionsList(
       | RequestAbortedError
       | RequestTimeoutError
       | ConnectionError
-    >
+    >,
+    { page: number }
   >
 > {
   const parsed = safeParse(
@@ -151,39 +152,42 @@ export async function usersSubscriptionsList(
 
   const nextFunc = (
     responseData: unknown,
-  ): Paginator<
-    Result<
-      operations.UsersSubscriptionsListResponse,
-      | errors.HTTPValidationError
-      | SDKError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | ConnectionError
-    >
-  > => {
+  ): {
+    next: Paginator<
+      Result<
+        operations.UsersSubscriptionsListResponse,
+        | errors.HTTPValidationError
+        | SDKError
+        | SDKValidationError
+        | UnexpectedClientError
+        | InvalidRequestError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | ConnectionError
+      >
+    >;
+    "~next"?: { page: number };
+  } => {
     const page = request?.page || 0;
     const nextPage = page + 1;
     const numPages = dlv(responseData, "pagination.max_page");
     if (numPages == null || numPages <= page) {
-      return () => null;
+      return { next: () => null };
     }
 
     if (!responseData) {
-      return () => null;
+      return { next: () => null };
     }
     const results = dlv(responseData, "items");
     if (!Array.isArray(results) || !results.length) {
-      return () => null;
+      return { next: () => null };
     }
     const limit = request?.limit || 0;
     if (results.length < limit) {
-      return () => null;
+      return { next: () => null };
     }
 
-    return () =>
+    const nextVal = () =>
       usersSubscriptionsList(
         client,
         {
@@ -192,8 +196,10 @@ export async function usersSubscriptionsList(
         },
         options,
       );
+
+    return { next: nextVal, "~next": { page: nextPage } };
   };
 
-  const page = { ...result, next: nextFunc(raw) };
+  const page = { ...result, ...nextFunc(raw) };
   return { ...page, ...createPageIterator(page, (v) => !v.ok) };
 }

package/src/lib/config.ts

@@ -60,7 +60,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.1.0",
-  sdkVersion: "0.17.0",
-  genVersion: "2.462.1",
-  userAgent: "speakeasy-sdk/typescript 0.17.0 2.462.1 0.1.0 @polar-sh/sdk",
+  sdkVersion: "0.17.2",
+  genVersion: "2.467.4",
+  userAgent: "speakeasy-sdk/typescript 0.17.2 2.467.4 0.1.0 @polar-sh/sdk",
 } as const;

package/src/lib/primitives.ts

@@ -58,3 +58,65 @@ export function remap<
 
   return out;
 }
+
+export function combineSignals(
+  ...signals: Array<AbortSignal | null | undefined>
+): AbortSignal | null {
+  const filtered: AbortSignal[] = [];
+  for (const signal of signals) {
+    if (signal) {
+      filtered.push(signal);
+    }
+  }
+
+  switch (filtered.length) {
+    case 0:
+    case 1:
+      return filtered[0] || null;
+    default:
+      if ("any" in AbortSignal && typeof AbortSignal.any === "function") {
+        return AbortSignal.any(filtered);
+      }
+      return abortSignalAny(filtered);
+  }
+}
+
+export function abortSignalAny(signals: AbortSignal[]): AbortSignal {
+  const controller = new AbortController();
+  const result = controller.signal;
+  if (!signals.length) {
+    return controller.signal;
+  }
+
+  if (signals.length === 1) {
+    return signals[0] || controller.signal;
+  }
+
+  for (const signal of signals) {
+    if (signal.aborted) {
+      return signal;
+    }
+  }
+
+  function abort(this: AbortSignal) {
+    controller.abort(this.reason);
+    clean();
+  }
+
+  const signalRefs: WeakRef<AbortSignal>[] = [];
+  function clean() {
+    for (const signalRef of signalRefs) {
+      const signal = signalRef.deref();
+      if (signal) {
+        signal.removeEventListener("abort", abort);
+      }
+    }
+  }
+
+  for (const signal of signals) {
+    signalRefs.push(new WeakRef(signal));
+    signal.addEventListener("abort", abort);
+  }
+
+  return result;
+}

package/src/sdk/advertisements.ts

@@ -20,7 +20,9 @@ export class Advertisements extends ClientSDK {
   async list(
     request: operations.AdvertisementsListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.AdvertisementsListResponse>> {
+  ): Promise<
+    PageIterator<operations.AdvertisementsListResponse, { page: number }>
+  > {
     return unwrapResultIterator(advertisementsList(
       this,
       request,

package/src/sdk/articles.ts

@@ -27,7 +27,7 @@ export class Articles extends ClientSDK {
   async list(
     request: operations.ArticlesListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.ArticlesListResponse>> {
+  ): Promise<PageIterator<operations.ArticlesListResponse, { page: number }>> {
     return unwrapResultIterator(articlesList(
       this,
       request,

package/src/sdk/benefits.ts

@@ -24,7 +24,7 @@ export class Benefits extends ClientSDK {
   async list(
     request: operations.BenefitsListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.BenefitsListResponse>> {
+  ): Promise<PageIterator<operations.BenefitsListResponse, { page: number }>> {
     return unwrapResultIterator(benefitsList(
       this,
       request,
@@ -115,7 +115,9 @@ export class Benefits extends ClientSDK {
   async grants(
     request: operations.BenefitsGrantsRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.BenefitsGrantsResponse>> {
+  ): Promise<
+    PageIterator<operations.BenefitsGrantsResponse, { page: number }>
+  > {
     return unwrapResultIterator(benefitsGrants(
       this,
       request,

package/src/sdk/checkoutlinks.ts

@@ -23,7 +23,9 @@ export class CheckoutLinks extends ClientSDK {
   async list(
     request: operations.CheckoutLinksListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.CheckoutLinksListResponse>> {
+  ): Promise<
+    PageIterator<operations.CheckoutLinksListResponse, { page: number }>
+  > {
     return unwrapResultIterator(checkoutLinksList(
       this,
       request,

package/src/sdk/clients.ts

@@ -23,7 +23,9 @@ export class Clients extends ClientSDK {
   async list(
     request: operations.Oauth2ClientsListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.Oauth2ClientsListResponse>> {
+  ): Promise<
+    PageIterator<operations.Oauth2ClientsListResponse, { page: number }>
+  > {
     return unwrapResultIterator(oauth2ClientsList(
       this,
       request,

package/src/sdk/custom.ts

@@ -25,7 +25,9 @@ export class Custom extends ClientSDK {
   async list(
     request: operations.CheckoutsCustomListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.CheckoutsCustomListResponse>> {
+  ): Promise<
+    PageIterator<operations.CheckoutsCustomListResponse, { page: number }>
+  > {
     return unwrapResultIterator(checkoutsCustomList(
       this,
       request,

package/src/sdk/customfields.ts

@@ -23,7 +23,9 @@ export class CustomFields extends ClientSDK {
   async list(
     request: operations.CustomFieldsListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.CustomFieldsListResponse>> {
+  ): Promise<
+    PageIterator<operations.CustomFieldsListResponse, { page: number }>
+  > {
     return unwrapResultIterator(customFieldsList(
       this,
       request,

package/src/sdk/discounts.ts

@@ -23,7 +23,7 @@ export class Discounts extends ClientSDK {
   async list(
     request: operations.DiscountsListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.DiscountsListResponse>> {
+  ): Promise<PageIterator<operations.DiscountsListResponse, { page: number }>> {
     return unwrapResultIterator(discountsList(
       this,
       request,

package/src/sdk/downloadables.ts

@@ -16,7 +16,9 @@ export class Downloadables extends ClientSDK {
   async list(
     request: operations.UsersDownloadablesListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.UsersDownloadablesListResponse>> {
+  ): Promise<
+    PageIterator<operations.UsersDownloadablesListResponse, { page: number }>
+  > {
     return unwrapResultIterator(usersDownloadablesList(
       this,
       request,

package/src/sdk/externalorganizations.ts

@@ -17,7 +17,9 @@ export class ExternalOrganizations extends ClientSDK {
   async list(
     request: operations.ExternalOrganizationsListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.ExternalOrganizationsListResponse>> {
+  ): Promise<
+    PageIterator<operations.ExternalOrganizationsListResponse, { page: number }>
+  > {
     return unwrapResultIterator(externalOrganizationsList(
       this,
       request,

package/src/sdk/files.ts

@@ -23,7 +23,7 @@ export class Files extends ClientSDK {
   async list(
     request: operations.FilesListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.FilesListResponse>> {
+  ): Promise<PageIterator<operations.FilesListResponse, { page: number }>> {
     return unwrapResultIterator(filesList(
       this,
       request,

package/src/sdk/licensekeys.ts

@@ -22,7 +22,9 @@ export class LicenseKeys extends ClientSDK {
   async list(
     request: operations.LicenseKeysListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.LicenseKeysListResponse>> {
+  ): Promise<
+    PageIterator<operations.LicenseKeysListResponse, { page: number }>
+  > {
     return unwrapResultIterator(licenseKeysList(
       this,
       request,

package/src/sdk/orders.ts

@@ -21,7 +21,7 @@ export class Orders extends ClientSDK {
   async list(
     request: operations.OrdersListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.OrdersListResponse>> {
+  ): Promise<PageIterator<operations.OrdersListResponse, { page: number }>> {
     return unwrapResultIterator(ordersList(
       this,
       request,

package/src/sdk/organizations.ts

@@ -22,7 +22,9 @@ export class Organizations extends ClientSDK {
   async list(
     request: operations.OrganizationsListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.OrganizationsListResponse>> {
+  ): Promise<
+    PageIterator<operations.OrganizationsListResponse, { page: number }>
+  > {
     return unwrapResultIterator(organizationsList(
       this,
       request,

package/src/sdk/polaradvertisements.ts

@@ -24,7 +24,9 @@ export class PolarAdvertisements extends ClientSDK {
   async list(
     request: operations.UsersAdvertisementsListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.UsersAdvertisementsListResponse>> {
+  ): Promise<
+    PageIterator<operations.UsersAdvertisementsListResponse, { page: number }>
+  > {
     return unwrapResultIterator(usersAdvertisementsList(
       this,
       request,

package/src/sdk/polarbenefits.ts

@@ -19,7 +19,9 @@ export class PolarBenefits extends ClientSDK {
   async list(
     request: operations.UsersBenefitsListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.UsersBenefitsListResponse>> {
+  ): Promise<
+    PageIterator<operations.UsersBenefitsListResponse, { page: number }>
+  > {
     return unwrapResultIterator(usersBenefitsList(
       this,
       request,

package/src/sdk/polarlicensekeys.ts

@@ -20,7 +20,9 @@ export class PolarLicenseKeys extends ClientSDK {
   async list(
     request: operations.UsersLicenseKeysListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.UsersLicenseKeysListResponse>> {
+  ): Promise<
+    PageIterator<operations.UsersLicenseKeysListResponse, { page: number }>
+  > {
     return unwrapResultIterator(usersLicenseKeysList(
       this,
       request,

package/src/sdk/polarorders.ts

@@ -21,7 +21,9 @@ export class PolarOrders extends ClientSDK {
   async list(
     request: operations.UsersOrdersListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.UsersOrdersListResponse>> {
+  ): Promise<
+    PageIterator<operations.UsersOrdersListResponse, { page: number }>
+  > {
     return unwrapResultIterator(usersOrdersList(
       this,
       request,

package/src/sdk/polarsubscriptions.ts

@@ -22,7 +22,9 @@ export class PolarSubscriptions extends ClientSDK {
   async list(
     request: operations.UsersSubscriptionsListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.UsersSubscriptionsListResponse>> {
+  ): Promise<
+    PageIterator<operations.UsersSubscriptionsListResponse, { page: number }>
+  > {
     return unwrapResultIterator(usersSubscriptionsList(
       this,
       request,

package/src/sdk/products.ts

@@ -23,7 +23,7 @@ export class Products extends ClientSDK {
   async list(
     request: operations.ProductsListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.ProductsListResponse>> {
+  ): Promise<PageIterator<operations.ProductsListResponse, { page: number }>> {
     return unwrapResultIterator(productsList(
       this,
       request,

package/src/sdk/repositories.ts

@@ -21,7 +21,9 @@ export class Repositories extends ClientSDK {
   async list(
     request: operations.RepositoriesListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.RepositoriesListResponse>> {
+  ): Promise<
+    PageIterator<operations.RepositoriesListResponse, { page: number }>
+  > {
     return unwrapResultIterator(repositoriesList(
       this,
       request,

package/src/sdk/subscriptions.ts

@@ -19,7 +19,9 @@ export class Subscriptions extends ClientSDK {
   async list(
     request: operations.SubscriptionsListRequest,
     options?: RequestOptions,
-  ): Promise<PageIterator<operations.SubscriptionsListResponse>> {
+  ): Promise<
+    PageIterator<operations.SubscriptionsListResponse, { page: number }>
+  > {
     return unwrapResultIterator(subscriptionsList(
       this,
       request,

package/src/types/operations.ts

@@ -6,9 +6,10 @@ import { Result } from "./fp.js";
 
 export type Paginator<V> = () => Promise<V & { next: Paginator<V> }> | null;
 
-export type PageIterator<V> = V & {
+export type PageIterator<V, PageState = unknown> = V & {
   next: Paginator<V>;
   [Symbol.asyncIterator]: () => AsyncIterableIterator<V>;
+  "~next"?: PageState | undefined;
 };
 
 export function createPageIterator<V>(
@@ -40,7 +41,9 @@ export function createPageIterator<V>(
  * terminates. It is useful in paginated SDK functions that have early return
  * paths when things go wrong.
  */
-export function haltIterator<V extends object>(v: V): PageIterator<V> {
+export function haltIterator<V extends object>(
+  v: V,
+): PageIterator<V, undefined> {
   return {
     ...v,
     next: () => null,
@@ -54,9 +57,9 @@ export function haltIterator<V extends object>(v: V): PageIterator<V> {
  * Converts an async iterator of `Result<V, E>` into an async iterator of `V`.
  * When error results occur, the underlying error value is thrown.
  */
-export async function unwrapResultIterator<V>(
-  iteratorPromise: Promise<PageIterator<Result<V, unknown>>>,
-): Promise<PageIterator<V>> {
+export async function unwrapResultIterator<V, PageState>(
+  iteratorPromise: Promise<PageIterator<Result<V, unknown>, PageState>>,
+): Promise<PageIterator<V, PageState>> {
   const resultIter = await iteratorPromise;
 
   if (!resultIter.ok) {
@@ -66,6 +69,7 @@ export async function unwrapResultIterator<V>(
   return {
     ...resultIter.value,
     next: unwrapPaginator(resultIter.next),
+    "~next": resultIter["~next"],
     [Symbol.asyncIterator]: async function* paginator() {
       for await (const page of resultIter) {
         if (!page.ok) {
@@ -97,3 +101,5 @@ function unwrapPaginator<V>(
     });
   };
 }
+
+export const URL_OVERRIDE = Symbol("URL_OVERRIDE");