// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { SGPClientError } from './error'; import { FinalRequestOptions } from '../internal/request-options'; import { defaultParseResponse } from '../internal/parse'; import { type SGPClient } from '../client'; import { APIPromise } from './api-promise'; import { type APIResponseProps } from '../internal/parse'; import { maybeObj } from '../internal/utils/values'; export type PageRequestOptions = Pick; export abstract class AbstractPage implements AsyncIterable { #client: SGPClient; protected options: FinalRequestOptions; protected response: Response; protected body: unknown; constructor(client: SGPClient, response: Response, body: unknown, options: FinalRequestOptions) { this.#client = client; this.options = options; this.response = response; this.body = body; } abstract nextPageRequestOptions(): PageRequestOptions | null; abstract getPaginatedItems(): Item[]; hasNextPage(): boolean { const items = this.getPaginatedItems(); if (!items.length) return false; return this.nextPageRequestOptions() != null; } async getNextPage(): Promise { const nextOptions = this.nextPageRequestOptions(); if (!nextOptions) { throw new SGPClientError( 'No next page expected; please check `.hasNextPage()` before calling `.getNextPage()`.', ); } return await this.#client.requestAPIList(this.constructor as any, nextOptions); } async *iterPages(): AsyncGenerator { let page: this = this; yield page; while (page.hasNextPage()) { page = await page.getNextPage(); yield page; } } async *[Symbol.asyncIterator](): AsyncGenerator { for await (const page of this.iterPages()) { for (const item of page.getPaginatedItems()) { yield item; } } } } /** * This subclass of Promise will resolve to an instantiated Page once the request completes. * * It also implements AsyncIterable to allow auto-paginating iteration on an unawaited list call, eg: * * for await (const item of client.items.list()) { * console.log(item) * } */ export class PagePromise< PageClass extends AbstractPage, Item = ReturnType[number], > extends APIPromise implements AsyncIterable { constructor( client: SGPClient, request: Promise, Page: new (...args: ConstructorParameters) => PageClass, ) { super( client, request, async (client, props) => new Page(client, props.response, await defaultParseResponse(client, props), props.options), ); } /** * Allow auto-paginating iteration on an unawaited list call, eg: * * for await (const item of client.items.list()) { * console.log(item) * } */ async *[Symbol.asyncIterator](): AsyncGenerator { const page = await this; for await (const item of page) { yield item; } } } export interface CursorPageResponse { has_more: boolean; items: Array; } export interface CursorPageParams { starting_after?: string; ending_before?: string; limit?: number; } export class CursorPage extends AbstractPage implements CursorPageResponse { has_more: boolean; items: Array; constructor( client: SGPClient, response: Response, body: CursorPageResponse, options: FinalRequestOptions, ) { super(client, response, body, options); this.has_more = body.has_more || false; this.items = body.items || []; } getPaginatedItems(): Item[] { return this.items ?? []; } override hasNextPage(): boolean { if (this.has_more === false) { return false; } return super.hasNextPage(); } nextPageRequestOptions(): PageRequestOptions | null { const items = this.getPaginatedItems(); const isForwards = !( typeof this.options.query === 'object' && 'ending_before' in (this.options.query || {}) ); if (isForwards) { const id = items[items.length - 1]?.id; if (!id) { return null; } return { ...this.options, query: { ...maybeObj(this.options.query), starting_after: id, }, }; } const id = items[0]?.id; if (!id) { return null; } return { ...this.options, query: { ...maybeObj(this.options.query), ending_before: id, }, }; } } export interface CursorPageVectorsResponse { has_more: boolean; vectors: Array; } export interface CursorPageVectorsParams { starting_after?: string; ending_before?: string; limit?: number; } export class CursorPageVectors extends AbstractPage implements CursorPageVectorsResponse { has_more: boolean; vectors: Array; constructor( client: SGPClient, response: Response, body: CursorPageVectorsResponse, options: FinalRequestOptions, ) { super(client, response, body, options); this.has_more = body.has_more || false; this.vectors = body.vectors || []; } getPaginatedItems(): Item[] { return this.vectors ?? []; } override hasNextPage(): boolean { if (this.has_more === false) { return false; } return super.hasNextPage(); } nextPageRequestOptions(): PageRequestOptions | null { const vectors = this.getPaginatedItems(); const isForwards = !( typeof this.options.query === 'object' && 'ending_before' in (this.options.query || {}) ); if (isForwards) { const id = vectors[vectors.length - 1]?.id; if (!id) { return null; } return { ...this.options, query: { ...maybeObj(this.options.query), starting_after: id, }, }; } const id = vectors[0]?.id; if (!id) { return null; } return { ...this.options, query: { ...maybeObj(this.options.query), ending_before: id, }, }; } } export interface CursorPageByNameResponse { has_more: boolean; items: Array; } export interface CursorPageByNameParams { starting_after?: string; ending_before?: string; limit?: number; } export class CursorPageByName extends AbstractPage implements CursorPageByNameResponse { has_more: boolean; items: Array; constructor( client: SGPClient, response: Response, body: CursorPageByNameResponse, options: FinalRequestOptions, ) { super(client, response, body, options); this.has_more = body.has_more || false; this.items = body.items || []; } getPaginatedItems(): Item[] { return this.items ?? []; } override hasNextPage(): boolean { if (this.has_more === false) { return false; } return super.hasNextPage(); } nextPageRequestOptions(): PageRequestOptions | null { const items = this.getPaginatedItems(); const isForwards = !( typeof this.options.query === 'object' && 'ending_before' in (this.options.query || {}) ); if (isForwards) { const name = items[items.length - 1]?.name; if (!name) { return null; } return { ...this.options, query: { ...maybeObj(this.options.query), starting_after: name, }, }; } const name = items[0]?.name; if (!name) { return null; } return { ...this.options, query: { ...maybeObj(this.options.query), ending_before: name, }, }; } } export interface APIListPageResponse { items: Array; } export class APIListPage extends AbstractPage implements APIListPageResponse { items: Array; constructor( client: SGPClient, response: Response, body: APIListPageResponse, options: FinalRequestOptions, ) { super(client, response, body, options); this.items = body.items || []; } getPaginatedItems(): Item[] { return this.items ?? []; } nextPageRequestOptions(): PageRequestOptions | null { return null; } }