truefoundry-gateway-sdk 0.0.2 → 0.1.0

package/dist/esm/api/types/index.d.mts

@@ -1,77 +1,105 @@
-export * from "./AgentApprovalDecision.mjs";
-export * from "./AgentApprovalDecisionAllow.mjs";
-export * from "./AgentApprovalDecisionDeny.mjs";
-export * from "./AgentApprovalDecisionMessage.mjs";
-export * from "./AgentApprovalOrToolResponseMessage.mjs";
-export * from "./AgentApprovalRequired.mjs";
-export * from "./AgentAssistantMessage.mjs";
-export * from "./AgentClientSideToolResponseMessage.mjs";
-export * from "./AgentEnrichedAssistantMessage.mjs";
-export * from "./AgentEnrichedAssistantMessageAudio.mjs";
-export * from "./AgentEnrichedAssistantMessageContent.mjs";
-export * from "./AgentEnrichedAssistantMessageContentOneItem.mjs";
-export * from "./AgentEnrichedAssistantMessageFunctionCall.mjs";
-export * from "./AgentEnrichedAssistantMessageThinkingBlocksItem.mjs";
-export * from "./AgentEnrichedToolCall.mjs";
-export * from "./AgentExecutionCreated.mjs";
-export * from "./AgentExecutionDone.mjs";
-export * from "./AgentExecutionError.mjs";
-export * from "./AgentExtendedDelta.mjs";
-export * from "./AgentExtendedDeltaFunctionCall.mjs";
-export * from "./AgentExtendedDeltaRole.mjs";
-export * from "./AgentExtendedDeltaThinkingBlocksItem.mjs";
-export * from "./AgentExtendedDeltaToolCall.mjs";
-export * from "./AgentFileUploadContentPart.mjs";
-export * from "./AgentFileUploadContentPartFile.mjs";
-export * from "./AgentFinishReason.mjs";
+export * from "./ActionRequiredEvent.mjs";
 export * from "./AgentInfo.mjs";
-export * from "./AgentInputUserMessage.mjs";
-export * from "./AgentInputUserMessageContent.mjs";
-export * from "./AgentInputUserMessageContentOneItem.mjs";
-export * from "./AgentLlmMessageDelta.mjs";
-export * from "./AgentLlmToolMessage.mjs";
-export * from "./AgentMcpAuthRequired.mjs";
-export * from "./AgentMcpInitializationInfo.mjs";
-export * from "./AgentMcpInitialize.mjs";
-export * from "./AgentMcpServerAuthInfo.mjs";
-export * from "./AgentMcpServerRequest.mjs";
-export * from "./AgentMcpTool.mjs";
-export * from "./AgentMcpToolCallInfo.mjs";
-export * from "./AgentModelParams.mjs";
-export * from "./AgentModelParamsReasoningEffort.mjs";
 export * from "./AgentParent.mjs";
-export * from "./AgentRawToolCall.mjs";
-export * from "./AgentRedactedThinkingBlock.mjs";
-export * from "./AgentResponseCreated.mjs";
-export * from "./AgentResponseDone.mjs";
-export * from "./AgentResponseDoneCancelled.mjs";
-export * from "./AgentResponseDoneCancelledCancellationReason.mjs";
-export * from "./AgentResponseDoneCompleted.mjs";
-export * from "./AgentResponseDoneError.mjs";
-export * from "./AgentResponseStreamingOutputEvent.mjs";
-export * from "./AgentResponsesBody.mjs";
-export * from "./AgentResponsesFormat.mjs";
-export * from "./AgentResponsesFormatJsonSchema.mjs";
-export * from "./AgentResponsesFormatJsonSchemaJsonSchema.mjs";
-export * from "./AgentResponsesFormatOne.mjs";
-export * from "./AgentResponsesFormatZero.mjs";
-export * from "./AgentResponsesInlineAgent.mjs";
-export * from "./AgentResponsesInlineAgentMessagesItem.mjs";
-export * from "./AgentResponsesInlineAgentSandbox.mjs";
-export * from "./AgentResponsesInput.mjs";
-export * from "./AgentResponsesSavedAgent.mjs";
-export * from "./AgentSandboxCreated.mjs";
-export * from "./AgentSkillMount.mjs";
-export * from "./AgentTextContentPart.mjs";
-export * from "./AgentThinkingBlock.mjs";
-export * from "./AgentToolCallRef.mjs";
-export * from "./AgentToolMessage.mjs";
-export * from "./AgentToolResponseRequired.mjs";
+export * from "./AgentSpec.mjs";
+export * from "./AgentSpecUserMessage.mjs";
+export * from "./ApprovalAllow.mjs";
+export * from "./ApprovalDecision.mjs";
+export * from "./ApprovalDeny.mjs";
+export * from "./AskUserQuestionsConfig.mjs";
+export * from "./BaseMcpAuthRequiredEvent.mjs";
+export * from "./BaseThreadDoneEvent.mjs";
+export * from "./CancelSessionResponse.mjs";
 export * from "./ChatCompletionChunkDeltaToolCall.mjs";
 export * from "./ChatCompletionChunkDeltaToolCallFunction.mjs";
 export * from "./ChatCompletionContentPartRefusal.mjs";
 export * from "./ChatCompletionContentPartText.mjs";
 export * from "./ChatCompletionMessageToolCall.mjs";
 export * from "./ChatCompletionMessageToolCallFunction.mjs";
+export * from "./ContextManagementConfig.mjs";
+export * from "./ContextManagementConfigCompaction.mjs";
+export * from "./DraftSession.mjs";
+export * from "./DynamicSubAgentsConfig.mjs";
+export * from "./ExtendedChunkDeltaToolCall.mjs";
+export * from "./FileContent.mjs";
+export * from "./FinishReason.mjs";
+export * from "./GenerativeUiConfig.mjs";
+export * from "./GetDraftSessionResponse.mjs";
+export * from "./GetSessionResponse.mjs";
+export * from "./GetTurnResponse.mjs";
+export * from "./LargeToolResponseConfig.mjs";
+export * from "./ListDraftSessionsOrder.mjs";
+export * from "./ListDraftSessionsResponse.mjs";
+export * from "./ListEventsOrder.mjs";
+export * from "./ListEventsResponse.mjs";
+export * from "./ListSessionsOrder.mjs";
+export * from "./ListSessionsResponse.mjs";
+export * from "./ListTurnsResponse.mjs";
+export * from "./McpAuthRequiredEvent.mjs";
+export * from "./McpInitializeEvent.mjs";
+export * from "./McpServer.mjs";
+export * from "./McpServerAuthInfo.mjs";
+export * from "./McpServerDisableToolsItem.mjs";
+export * from "./McpServerEnableToolsItem.mjs";
+export * from "./McpServerInitInfo.mjs";
+export * from "./McpServerPreloadToolsItem.mjs";
+export * from "./McpServerRequireApprovalForToolsItem.mjs";
+export * from "./McpToolInfo.mjs";
+export * from "./Model.mjs";
+export * from "./ModelMessageDeltaEvent.mjs";
+export * from "./ModelMessageEvent.mjs";
+export * from "./ModelMessageEventContent.mjs";
+export * from "./ModelMessageEventContentOneItem.mjs";
+export * from "./ModelMessageUsage.mjs";
+export * from "./ModelMessageUsageInputTokensBreakdown.mjs";
+export * from "./ModelParams.mjs";
+export * from "./PreviousTurnIdInput.mjs";
+export * from "./RawToolCall.mjs";
 export * from "./RequestErrorResponse.mjs";
 export * from "./RequestErrorResponseError.mjs";
+export * from "./ResponseFormat.mjs";
+export * from "./ResponseFormatJsonSchema.mjs";
+export * from "./ResponseFormatJsonSchemaJsonSchema.mjs";
+export * from "./ResponseFormatOne.mjs";
+export * from "./ResponseFormatZero.mjs";
+export * from "./RuntimeConfig.mjs";
+export * from "./SandboxConfig.mjs";
+export * from "./SandboxCreatedEvent.mjs";
+export * from "./Session.mjs";
+export * from "./SkillMount.mjs";
+export * from "./Subject.mjs";
+export * from "./TextContent.mjs";
+export * from "./ThreadCreatedEvent.mjs";
+export * from "./ThreadDoneEvent.mjs";
+export * from "./ThreadState.mjs";
+export * from "./ThreadStateDone.mjs";
+export * from "./ThreadStateError.mjs";
+export * from "./TokenPagination.mjs";
+export * from "./ToolApprovalRequiredEvent.mjs";
+export * from "./ToolCall.mjs";
+export * from "./ToolCallRef.mjs";
+export * from "./ToolInfo.mjs";
+export * from "./ToolResponseEvent.mjs";
+export * from "./ToolResponseRequiredEvent.mjs";
+export * from "./TrueFoundrySystemToolInfo.mjs";
+export * from "./Turn.mjs";
+export * from "./TurnCreatedEvent.mjs";
+export * from "./TurnDoneEvent.mjs";
+export * from "./TurnDoneEventState.mjs";
+export * from "./TurnEvent.mjs";
+export * from "./TurnInputItem.mjs";
+export * from "./TurnState.mjs";
+export * from "./TurnStateCancelled.mjs";
+export * from "./TurnStateCancelledReason.mjs";
+export * from "./TurnStateDone.mjs";
+export * from "./TurnStateDoneOutput.mjs";
+export * from "./TurnStateDoneOutputContent.mjs";
+export * from "./TurnStateDoneOutputContentOneItem.mjs";
+export * from "./TurnStateError.mjs";
+export * from "./TurnStateRunning.mjs";
+export * from "./TurnStreamingEvent.mjs";
+export * from "./UserMessage.mjs";
+export * from "./UserMessageContent.mjs";
+export * from "./UserMessageContentItem.mjs";
+export * from "./UserToolApprovalEvent.mjs";
+export * from "./UserToolResponseEvent.mjs";

package/dist/esm/api/types/index.mjs

@@ -1,77 +1,105 @@
-export * from "./AgentApprovalDecision.mjs";
-export * from "./AgentApprovalDecisionAllow.mjs";
-export * from "./AgentApprovalDecisionDeny.mjs";
-export * from "./AgentApprovalDecisionMessage.mjs";
-export * from "./AgentApprovalOrToolResponseMessage.mjs";
-export * from "./AgentApprovalRequired.mjs";
-export * from "./AgentAssistantMessage.mjs";
-export * from "./AgentClientSideToolResponseMessage.mjs";
-export * from "./AgentEnrichedAssistantMessage.mjs";
-export * from "./AgentEnrichedAssistantMessageAudio.mjs";
-export * from "./AgentEnrichedAssistantMessageContent.mjs";
-export * from "./AgentEnrichedAssistantMessageContentOneItem.mjs";
-export * from "./AgentEnrichedAssistantMessageFunctionCall.mjs";
-export * from "./AgentEnrichedAssistantMessageThinkingBlocksItem.mjs";
-export * from "./AgentEnrichedToolCall.mjs";
-export * from "./AgentExecutionCreated.mjs";
-export * from "./AgentExecutionDone.mjs";
-export * from "./AgentExecutionError.mjs";
-export * from "./AgentExtendedDelta.mjs";
-export * from "./AgentExtendedDeltaFunctionCall.mjs";
-export * from "./AgentExtendedDeltaRole.mjs";
-export * from "./AgentExtendedDeltaThinkingBlocksItem.mjs";
-export * from "./AgentExtendedDeltaToolCall.mjs";
-export * from "./AgentFileUploadContentPart.mjs";
-export * from "./AgentFileUploadContentPartFile.mjs";
-export * from "./AgentFinishReason.mjs";
+export * from "./ActionRequiredEvent.mjs";
 export * from "./AgentInfo.mjs";
-export * from "./AgentInputUserMessage.mjs";
-export * from "./AgentInputUserMessageContent.mjs";
-export * from "./AgentInputUserMessageContentOneItem.mjs";
-export * from "./AgentLlmMessageDelta.mjs";
-export * from "./AgentLlmToolMessage.mjs";
-export * from "./AgentMcpAuthRequired.mjs";
-export * from "./AgentMcpInitializationInfo.mjs";
-export * from "./AgentMcpInitialize.mjs";
-export * from "./AgentMcpServerAuthInfo.mjs";
-export * from "./AgentMcpServerRequest.mjs";
-export * from "./AgentMcpTool.mjs";
-export * from "./AgentMcpToolCallInfo.mjs";
-export * from "./AgentModelParams.mjs";
-export * from "./AgentModelParamsReasoningEffort.mjs";
 export * from "./AgentParent.mjs";
-export * from "./AgentRawToolCall.mjs";
-export * from "./AgentRedactedThinkingBlock.mjs";
-export * from "./AgentResponseCreated.mjs";
-export * from "./AgentResponseDone.mjs";
-export * from "./AgentResponseDoneCancelled.mjs";
-export * from "./AgentResponseDoneCancelledCancellationReason.mjs";
-export * from "./AgentResponseDoneCompleted.mjs";
-export * from "./AgentResponseDoneError.mjs";
-export * from "./AgentResponseStreamingOutputEvent.mjs";
-export * from "./AgentResponsesBody.mjs";
-export * from "./AgentResponsesFormat.mjs";
-export * from "./AgentResponsesFormatJsonSchema.mjs";
-export * from "./AgentResponsesFormatJsonSchemaJsonSchema.mjs";
-export * from "./AgentResponsesFormatOne.mjs";
-export * from "./AgentResponsesFormatZero.mjs";
-export * from "./AgentResponsesInlineAgent.mjs";
-export * from "./AgentResponsesInlineAgentMessagesItem.mjs";
-export * from "./AgentResponsesInlineAgentSandbox.mjs";
-export * from "./AgentResponsesInput.mjs";
-export * from "./AgentResponsesSavedAgent.mjs";
-export * from "./AgentSandboxCreated.mjs";
-export * from "./AgentSkillMount.mjs";
-export * from "./AgentTextContentPart.mjs";
-export * from "./AgentThinkingBlock.mjs";
-export * from "./AgentToolCallRef.mjs";
-export * from "./AgentToolMessage.mjs";
-export * from "./AgentToolResponseRequired.mjs";
+export * from "./AgentSpec.mjs";
+export * from "./AgentSpecUserMessage.mjs";
+export * from "./ApprovalAllow.mjs";
+export * from "./ApprovalDecision.mjs";
+export * from "./ApprovalDeny.mjs";
+export * from "./AskUserQuestionsConfig.mjs";
+export * from "./BaseMcpAuthRequiredEvent.mjs";
+export * from "./BaseThreadDoneEvent.mjs";
+export * from "./CancelSessionResponse.mjs";
 export * from "./ChatCompletionChunkDeltaToolCall.mjs";
 export * from "./ChatCompletionChunkDeltaToolCallFunction.mjs";
 export * from "./ChatCompletionContentPartRefusal.mjs";
 export * from "./ChatCompletionContentPartText.mjs";
 export * from "./ChatCompletionMessageToolCall.mjs";
 export * from "./ChatCompletionMessageToolCallFunction.mjs";
+export * from "./ContextManagementConfig.mjs";
+export * from "./ContextManagementConfigCompaction.mjs";
+export * from "./DraftSession.mjs";
+export * from "./DynamicSubAgentsConfig.mjs";
+export * from "./ExtendedChunkDeltaToolCall.mjs";
+export * from "./FileContent.mjs";
+export * from "./FinishReason.mjs";
+export * from "./GenerativeUiConfig.mjs";
+export * from "./GetDraftSessionResponse.mjs";
+export * from "./GetSessionResponse.mjs";
+export * from "./GetTurnResponse.mjs";
+export * from "./LargeToolResponseConfig.mjs";
+export * from "./ListDraftSessionsOrder.mjs";
+export * from "./ListDraftSessionsResponse.mjs";
+export * from "./ListEventsOrder.mjs";
+export * from "./ListEventsResponse.mjs";
+export * from "./ListSessionsOrder.mjs";
+export * from "./ListSessionsResponse.mjs";
+export * from "./ListTurnsResponse.mjs";
+export * from "./McpAuthRequiredEvent.mjs";
+export * from "./McpInitializeEvent.mjs";
+export * from "./McpServer.mjs";
+export * from "./McpServerAuthInfo.mjs";
+export * from "./McpServerDisableToolsItem.mjs";
+export * from "./McpServerEnableToolsItem.mjs";
+export * from "./McpServerInitInfo.mjs";
+export * from "./McpServerPreloadToolsItem.mjs";
+export * from "./McpServerRequireApprovalForToolsItem.mjs";
+export * from "./McpToolInfo.mjs";
+export * from "./Model.mjs";
+export * from "./ModelMessageDeltaEvent.mjs";
+export * from "./ModelMessageEvent.mjs";
+export * from "./ModelMessageEventContent.mjs";
+export * from "./ModelMessageEventContentOneItem.mjs";
+export * from "./ModelMessageUsage.mjs";
+export * from "./ModelMessageUsageInputTokensBreakdown.mjs";
+export * from "./ModelParams.mjs";
+export * from "./PreviousTurnIdInput.mjs";
+export * from "./RawToolCall.mjs";
 export * from "./RequestErrorResponse.mjs";
 export * from "./RequestErrorResponseError.mjs";
+export * from "./ResponseFormat.mjs";
+export * from "./ResponseFormatJsonSchema.mjs";
+export * from "./ResponseFormatJsonSchemaJsonSchema.mjs";
+export * from "./ResponseFormatOne.mjs";
+export * from "./ResponseFormatZero.mjs";
+export * from "./RuntimeConfig.mjs";
+export * from "./SandboxConfig.mjs";
+export * from "./SandboxCreatedEvent.mjs";
+export * from "./Session.mjs";
+export * from "./SkillMount.mjs";
+export * from "./Subject.mjs";
+export * from "./TextContent.mjs";
+export * from "./ThreadCreatedEvent.mjs";
+export * from "./ThreadDoneEvent.mjs";
+export * from "./ThreadState.mjs";
+export * from "./ThreadStateDone.mjs";
+export * from "./ThreadStateError.mjs";
+export * from "./TokenPagination.mjs";
+export * from "./ToolApprovalRequiredEvent.mjs";
+export * from "./ToolCall.mjs";
+export * from "./ToolCallRef.mjs";
+export * from "./ToolInfo.mjs";
+export * from "./ToolResponseEvent.mjs";
+export * from "./ToolResponseRequiredEvent.mjs";
+export * from "./TrueFoundrySystemToolInfo.mjs";
+export * from "./Turn.mjs";
+export * from "./TurnCreatedEvent.mjs";
+export * from "./TurnDoneEvent.mjs";
+export * from "./TurnDoneEventState.mjs";
+export * from "./TurnEvent.mjs";
+export * from "./TurnInputItem.mjs";
+export * from "./TurnState.mjs";
+export * from "./TurnStateCancelled.mjs";
+export * from "./TurnStateCancelledReason.mjs";
+export * from "./TurnStateDone.mjs";
+export * from "./TurnStateDoneOutput.mjs";
+export * from "./TurnStateDoneOutputContent.mjs";
+export * from "./TurnStateDoneOutputContentOneItem.mjs";
+export * from "./TurnStateError.mjs";
+export * from "./TurnStateRunning.mjs";
+export * from "./TurnStreamingEvent.mjs";
+export * from "./UserMessage.mjs";
+export * from "./UserMessageContent.mjs";
+export * from "./UserMessageContentItem.mjs";
+export * from "./UserToolApprovalEvent.mjs";
+export * from "./UserToolResponseEvent.mjs";

package/dist/esm/auth/BearerAuthProvider.d.mts

@@ -1,5 +1,5 @@
 import * as core from "../core/index.mjs";
-declare const TOKEN_PARAM: "token";
+declare const TOKEN_PARAM: "apiKey";
 export declare class BearerAuthProvider implements core.AuthProvider {
     private readonly options;
     constructor(options: BearerAuthProvider.Options);

package/dist/esm/auth/BearerAuthProvider.mjs

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import * as core from "../core/index.mjs";
 import * as errors from "../errors/index.mjs";
-const TOKEN_PARAM = "token";
+const TOKEN_PARAM = "apiKey";
 const ENV_TOKEN = "TFY_API_KEY";
 export class BearerAuthProvider {
     constructor(options) {
@@ -23,14 +23,14 @@ export class BearerAuthProvider {
     getAuthRequest() {
         return __awaiter(this, arguments, void 0, function* ({ endpointMetadata, } = {}) {
             var _a, _b;
-            const token = (_a = (yield core.Supplier.get(this.options[TOKEN_PARAM]))) !== null && _a !== void 0 ? _a : (_b = process.env) === null || _b === void 0 ? void 0 : _b[ENV_TOKEN];
-            if (token == null) {
-                throw new errors.TruefoundryGatewayError({
+            const apiKey = (_a = (yield core.Supplier.get(this.options[TOKEN_PARAM]))) !== null && _a !== void 0 ? _a : (_b = process.env) === null || _b === void 0 ? void 0 : _b[ENV_TOKEN];
+            if (apiKey == null) {
+                throw new errors.TrueFoundryGatewayError({
                     message: BearerAuthProvider.AUTH_CONFIG_ERROR_MESSAGE,
                 });
             }
             return {
-                headers: { Authorization: `Bearer ${token}` },
+                headers: { Authorization: `Bearer ${apiKey}` },
             };
         });
     }

package/dist/esm/core/exports.d.mts

@@ -1 +1,2 @@
 export * from "./logging/exports.mjs";
+export * from "./pagination/exports.mjs";

package/dist/esm/core/exports.mjs

@@ -1 +1,2 @@
 export * from "./logging/exports.mjs";
+export * from "./pagination/exports.mjs";

package/dist/esm/core/fetcher/getResponseBody.mjs

@@ -9,6 +9,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { fromJson } from "../json.mjs";
 import { getBinaryResponse } from "./BinaryResponse.mjs";
+// Pins the upstream Response so undici's FinalizationRegistry can't GC it and cancel the body stream.
+function retainResponse(target, response) {
+    Object.defineProperty(target, "__fern_response_ref", {
+        value: response,
+        enumerable: false,
+        configurable: true,
+        writable: false,
+    });
+}
 export function getResponseBody(response, responseType) {
     return __awaiter(this, void 0, void 0, function* () {
         switch (responseType) {
@@ -28,6 +37,7 @@ export function getResponseBody(response, responseType) {
                         },
                     };
                 }
+                retainResponse(response.body, response);
                 return response.body;
             case "streaming":
                 if (response.body == null) {
@@ -39,6 +49,7 @@ export function getResponseBody(response, responseType) {
                         },
                     };
                 }
+                retainResponse(response.body, response);
                 return response.body;
             case "text":
                 return yield response.text();

package/dist/esm/core/fetcher/signals.mjs

@@ -10,11 +10,19 @@ export function anySignal(...args) {
     for (const signal of signals) {
         if (signal.aborted) {
             controller.abort(signal === null || signal === void 0 ? void 0 : signal.reason);
-            break;
+            return controller.signal;
         }
         signal.addEventListener("abort", () => controller.abort(signal === null || signal === void 0 ? void 0 : signal.reason), {
             signal: controller.signal,
         });
+        // Re-check after adding listener: the signal may have aborted
+        // between the initial `signal.aborted` check and the `addEventListener`
+        // call above. If it did, the abort event was already dispatched and
+        // the listener will never fire — we must manually abort.
+        if (signal.aborted) {
+            controller.abort(signal === null || signal === void 0 ? void 0 : signal.reason);
+            return controller.signal;
+        }
     }
     return controller.signal;
 }

package/dist/esm/core/index.d.mts

@@ -2,6 +2,9 @@ export * from "./auth/index.mjs";
 export * from "./base64.mjs";
 export * from "./fetcher/index.mjs";
 export * as logging from "./logging/index.mjs";
+export * from "./pagination/index.mjs";
 export * from "./runtime/index.mjs";
+export * as serialization from "./schemas/index.mjs";
 export * from "./stream/index.mjs";
 export * as url from "./url/index.mjs";
+export * from "./utils/index.mjs";

package/dist/esm/core/index.mjs

@@ -2,6 +2,9 @@ export * from "./auth/index.mjs";
 export * from "./base64.mjs";
 export * from "./fetcher/index.mjs";
 export * as logging from "./logging/index.mjs";
+export * from "./pagination/index.mjs";
 export * from "./runtime/index.mjs";
+export * as serialization from "./schemas/index.mjs";
 export * from "./stream/index.mjs";
 export * as url from "./url/index.mjs";
+export * from "./utils/index.mjs";

package/dist/esm/core/pagination/Page.d.mts

@@ -0,0 +1,33 @@
+import type { HttpResponsePromise, RawResponse } from "../fetcher/index.mjs";
+/**
+ * A page of results from a paginated API.
+ *
+ * @template T The type of the items in the page.
+ * @template R The type of the API response.
+ */
+export declare class Page<T, R = unknown> implements AsyncIterable<T> {
+    data: T[];
+    rawResponse: RawResponse;
+    response: R;
+    private _hasNextPage;
+    private getItems;
+    private loadNextPage;
+    constructor({ response, rawResponse, hasNextPage, getItems, loadPage, }: {
+        response: R;
+        rawResponse: RawResponse;
+        hasNextPage: (response: R) => boolean;
+        getItems: (response: R) => T[];
+        loadPage: (response: R) => HttpResponsePromise<R>;
+    });
+    /**
+     * Retrieves the next page
+     * @returns this
+     */
+    getNextPage(): Promise<this>;
+    /**
+     * @returns whether there is a next page to load
+     */
+    hasNextPage(): boolean;
+    private iterMessages;
+    [Symbol.asyncIterator](): AsyncIterator<T, void, unknown>;
+}

package/dist/esm/core/pagination/Page.mjs

@@ -0,0 +1,97 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
+    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+/**
+ * A page of results from a paginated API.
+ *
+ * @template T The type of the items in the page.
+ * @template R The type of the API response.
+ */
+export class Page {
+    constructor({ response, rawResponse, hasNextPage, getItems, loadPage, }) {
+        this.response = response;
+        this.rawResponse = rawResponse;
+        this.data = getItems(response);
+        this._hasNextPage = hasNextPage;
+        this.getItems = getItems;
+        this.loadNextPage = loadPage;
+    }
+    /**
+     * Retrieves the next page
+     * @returns this
+     */
+    getNextPage() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data, rawResponse } = yield this.loadNextPage(this.response).withRawResponse();
+            this.response = data;
+            this.rawResponse = rawResponse;
+            this.data = this.getItems(this.response);
+            return this;
+        });
+    }
+    /**
+     * @returns whether there is a next page to load
+     */
+    hasNextPage() {
+        return this._hasNextPage(this.response);
+    }
+    iterMessages() {
+        return __asyncGenerator(this, arguments, function* iterMessages_1() {
+            for (const item of this.data) {
+                yield yield __await(item);
+            }
+            while (this.hasNextPage()) {
+                yield __await(this.getNextPage());
+                for (const item of this.data) {
+                    yield yield __await(item);
+                }
+            }
+        });
+    }
+    [Symbol.asyncIterator]() {
+        return __asyncGenerator(this, arguments, function* _a() {
+            var _b, e_1, _c, _d;
+            try {
+                for (var _e = true, _f = __asyncValues(this.iterMessages()), _g; _g = yield __await(_f.next()), _b = _g.done, !_b; _e = true) {
+                    _d = _g.value;
+                    _e = false;
+                    const message = _d;
+                    yield yield __await(message);
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_e && !_b && (_c = _f.return)) yield __await(_c.call(_f));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        });
+    }
+}

package/dist/esm/core/pagination/exports.d.mts

@@ -0,0 +1 @@
+export type { Page } from "./Page.mjs";

package/dist/esm/core/pagination/exports.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/core/pagination/index.d.mts

@@ -0,0 +1 @@
+export { Page } from "./Page.mjs";

package/dist/esm/core/pagination/index.mjs

@@ -0,0 +1 @@
+export { Page } from "./Page.mjs";