@spoot/hostfully-api 1.0.0

package/dist/src/PropertiesApi.js

@@ -0,0 +1,183 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertiesApi = void 0;
+const zod_1 = require("zod");
+const rx_1 = require("@spoot/rx");
+const pagination_1 = require("./pagination");
+const PropertySchema = zod_1.z.object({
+    name: zod_1.z.string(),
+    isActive: zod_1.z.boolean(),
+    uid: zod_1.z.string().uuid(),
+    showPropertyExactLocation: zod_1.z.boolean(),
+    cancellationPolicy: zod_1.z.string().nullable(),
+    availability: zod_1.z.object({
+        allowBookingRequestsAboveMaximumStay: zod_1.z.boolean().nullable(),
+        allowBookingRequestWhenOutOfLeadTime: zod_1.z.boolean().nullable(),
+        baseGuests: zod_1.z.number(),
+        bookingLeadTime: zod_1.z.number().nullable(),
+        bookingWindow: zod_1.z.number().nullable(),
+        checkInTimeEnd: zod_1.z.number().nullable(),
+        checkInTimeEndFlexible: zod_1.z.boolean().nullable(),
+        checkInTimeStart: zod_1.z.number().nullable(),
+        checkOutTime: zod_1.z.number().nullable(),
+        daysOfTheWeekToCheckInOn: zod_1.z.array(zod_1.z.string()),
+        maxGuests: zod_1.z.number(),
+        maximumStay: zod_1.z.number().nullable(),
+        minimumStay: zod_1.z.number().nullable(),
+        minimumWeekendStay: zod_1.z.number().nullable(),
+        turnOverDays: zod_1.z.number().nullable(),
+    }),
+    address: zod_1.z.object({
+        address: zod_1.z.string().nullable(),
+        address2: zod_1.z.string().nullable(),
+        city: zod_1.z.string().nullable(),
+        state: zod_1.z.string().nullable(),
+        zipCode: zod_1.z.string().nullable(),
+    }),
+    pricing: zod_1.z.object({
+        taxRate: zod_1.z.number().nullable(),
+        ignoreTaxRateChargeOverXDays: zod_1.z.boolean().nullable(),
+        daysOverWhichTaxRateChargeShouldBeIgnored: zod_1.z.number().nullable(),
+        cleaningFeeTaxRate: zod_1.z.number().nullable(),
+        extraGuestFee: zod_1.z.number(),
+    }),
+});
+const PropertyDescriptionsSchema = zod_1.z.object({
+    name: zod_1.z.string().nullable(),
+    shortSummary: zod_1.z.string().nullable(),
+    summary: zod_1.z.string().nullable(),
+    notes: zod_1.z.string().nullable(),
+    access: zod_1.z.string().nullable(),
+    transit: zod_1.z.string().nullable(),
+    interaction: zod_1.z.string().nullable(),
+    neighbourhood: zod_1.z.string().nullable(),
+    space: zod_1.z.string().nullable(),
+    houseManual: zod_1.z.string().nullable(),
+    locale: zod_1.z.string(),
+});
+class PropertiesApi {
+    api;
+    constructor(api) {
+        this.api = api;
+    }
+    async list() {
+        return await rx_1.Rx.firstValueFrom(rx_1.Rx.defer(() => (0, pagination_1.scan)(async (cursor) => await this.api.transport.fetch({
+            method: "GET",
+            path: "/api/v3.1/properties",
+            query: {
+                agencyUid: this.api.agencyUid,
+                _cursor: cursor,
+                _limit: "100",
+            },
+            response: zod_1.z.object({
+                properties: zod_1.z.array(PropertySchema),
+                _paging: pagination_1.PagingSchema,
+            }),
+        }))).pipe(rx_1.Rx.mergeMap((resp) => resp.properties), rx_1.Rx.toArray()));
+    }
+    async patch(property, update) {
+        await this.api.transport.fetch({
+            path: `/api/v3.1/properties/${property.uid}`,
+            method: "PATCH",
+            body: update,
+            response: null,
+        });
+    }
+    async getCustomData(property) {
+        const fields = await this.api.transport.fetch({
+            method: "GET",
+            path: "/api/v3.1/custom-data",
+            query: {
+                propertyUid: property.uid,
+            },
+            response: zod_1.z.object({
+                customData: zod_1.z.array(zod_1.z.object({
+                    propertyUid: zod_1.z.string().nullable(),
+                    leadUid: zod_1.z.string().nullable(),
+                    unitUid: zod_1.z.string().nullable(),
+                    text: zod_1.z.string(),
+                    customDataField: zod_1.z.object({
+                        agencyUid: zod_1.z.string(),
+                        uid: zod_1.z.string(),
+                        type: zod_1.z.enum(["TEXT", "LONG_TEXT"]),
+                        name: zod_1.z.string(),
+                        variable: zod_1.z.string(),
+                        index: zod_1.z.number(),
+                    }),
+                })),
+                _metadata: zod_1.z.object({
+                    count: zod_1.z.number(),
+                }),
+            }),
+        });
+        return new Map(fields.customData.flatMap((d) => {
+            if (!d.propertyUid) {
+                return [];
+            }
+            return [[d.customDataField.uid, d.text]];
+        }));
+    }
+    async setCustomData(property, fieldUid, value) {
+        await this.api.transport.fetch({
+            method: "POST",
+            path: "/api/v3.1/custom-data",
+            body: {
+                propertyUid: property.uid,
+                customDataFieldUid: fieldUid,
+                text: value,
+            },
+            response: null,
+        });
+    }
+    async deleteCustomData(property, fieldUid) {
+        await this.api.transport.fetch({
+            method: "DELETE",
+            path: "/api/v3.1/custom-data",
+            query: {
+                propertyUid: property.uid,
+                customDataFieldUid: fieldUid,
+            },
+            response: null,
+        });
+    }
+    async getDescriptions(property) {
+        const resp = await this.api.transport.fetch({
+            method: "GET",
+            path: "/api/v3.1/property-descriptions",
+            query: { propertyUid: property.uid },
+            response: zod_1.z.object({
+                propertyDescriptions: zod_1.z.array(PropertyDescriptionsSchema),
+            }),
+        });
+        if (resp.propertyDescriptions.length !== 1) {
+            throw new Error(`expected to get exactly one set of property descriptions for "${property.name}", got ${resp.propertyDescriptions.length}`);
+        }
+        return resp.propertyDescriptions[0];
+    }
+    async updateDescriptions(property, updates) {
+        const current = await this.getDescriptions(property);
+        await this.api.transport.fetch({
+            method: "PUT",
+            path: `/api/v3.1/property-descriptions/${property.uid}`,
+            body: {
+                locale: current.locale,
+                name: "name" in updates ? updates.name : current.name,
+                shortSummary: "shortSummary" in updates
+                    ? updates.shortSummary
+                    : current.shortSummary,
+                summary: "summary" in updates ? updates.summary : current.summary,
+                notes: "notes" in updates ? updates.notes : current.notes,
+                access: "access" in updates ? updates.access : current.access,
+                transit: "transit" in updates ? updates.transit : current.transit,
+                interaction: "interaction" in updates ? updates.interaction : current.interaction,
+                neighbourhood: "neighbourhood" in updates
+                    ? updates.neighbourhood
+                    : current.neighbourhood,
+                space: "space" in updates ? updates.space : current.space,
+                houseManual: "houseManual" in updates ? updates.houseManual : current.houseManual,
+            },
+            response: null,
+        });
+    }
+}
+exports.PropertiesApi = PropertiesApi;

package/dist/src/RateLimiting.d.ts

@@ -0,0 +1,6 @@
+export declare class RateLimiting {
+    private remainingRequests;
+    private decriment;
+    take(): Promise<void>;
+    onResponse(respHeaders: Record<string, string>): void;
+}

package/dist/src/RateLimiting.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimiting = void 0;
+const promises_1 = require("timers/promises");
+const rx_1 = require("@spoot/rx");
+class RateLimiting {
+    // the starting value will be replaced very quickly, but to avoid slowing down the first request we assume that all of our capacity is available
+    remainingRequests = new rx_1.Rx.BehaviorSubject(10000);
+    decriment() {
+        this.remainingRequests.next(this.remainingRequests.getValue() - 1);
+    }
+    async take() {
+        for (let remaining = this.remainingRequests.getValue(); true; remaining = this.remainingRequests.getValue()) {
+            if (remaining > 1000) {
+                this.decriment();
+                return;
+            }
+            if (remaining > 700) {
+                console.log("Running low on requests, slowing down to avoid hitting limit");
+                await (0, promises_1.setTimeout)(1000);
+                this.decriment();
+                return;
+            }
+            if (remaining > 500) {
+                console.log("Running very low on requests, delaying request by 5 seconds to avoid hitting limit");
+                await (0, promises_1.setTimeout)(5000);
+                this.decriment();
+                return;
+            }
+            if (remaining > 100) {
+                console.log("Running critically low on requests, delaying request by 1 minute to avoid hitting limit");
+                await (0, promises_1.setTimeout)(60000);
+                this.decriment();
+                return;
+            }
+            console.log("Ran out of requests, waiting for more");
+            await this.remainingRequests.pipe(rx_1.Rx.filter((n) => n > 0)).toPromise();
+        }
+    }
+    onResponse(respHeaders) {
+        const remaining = respHeaders["x-ratelimit-remaining"];
+        if (remaining) {
+            const n = Number(remaining);
+            if (!Number.isNaN(n)) {
+                this.remainingRequests.next(n);
+            }
+        }
+    }
+}
+exports.RateLimiting = RateLimiting;

package/dist/src/Transport.d.ts

@@ -0,0 +1,13 @@
+import { GqlQuery } from "@spoot/gql";
+import { z } from "zod";
+export interface FetchOptions<Response> {
+    path: string;
+    query?: Record<string, string | undefined | null>;
+    method: string;
+    body?: object;
+    response: z.Schema<Response> | null;
+}
+export interface Transport {
+    fetchGql<Response>(query: GqlQuery, schema: z.Schema<Response>): Promise<Response>;
+    fetch<Response>(options: FetchOptions<Response>): Promise<Response>;
+}

package/dist/src/Transport.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/enums.d.ts

@@ -0,0 +1,7 @@
+import { z } from "zod";
+export declare const LeadStatusSchema: z.ZodEnum<["BLOCKED", "NEW", "ON_HOLD", "CLOSED", "PENDING", "DECLINED", "BOOKED", "CANCELLED", "IGNORED", "DUPLICATE", "SAMPLE"]>;
+export declare const VrboFeeTypeSchema: z.ZodEnum<["ADDITIONAL_BED", "ADMINISTRATIVE", "AIR_CONDITIONING", "ARRIVAL_EARLY", "ARRIVAL_LATE", "ASSOCIATION_PROPERTY", "BABY_BED", "BOOKING_EARLY", "BOOKING_LATE", "CLASS", "CLUB", "CONCIERGE", "DEPARTURE_EARLY", "DEPARTURE_LATE", "ELECTRICITY", "EQUIPMENT", "FOOD", "GARDENING", "GAS", "HEATING", "HIGH_CHAIR", "HOT_TUB", "INTERNET", "LABOR", "LAUNDRY", "LINENS", "LINENS_BATH", "LINENS_BED", "MANAGEMENT", "OIL", "ON_SITE_PAYMENT_METHOD", "PARKING", "PET", "PHONE", "POOL", "POOL_HEATING", "RENT", "RESORT", "SPA", "TAX", "TOILETRIES", "TOUR", "TRANSPORTATION", "UTENSILS_CLEANING", "UTENSILS_FOOD", "VEHICLE", "WAIVER_DAMAGE", "WATER", "WATER_CRAFT", "WATER_CRAFT_MOORING", "WATER_DRINKING", "WOOD"]>;
+export declare const MarriottFeeTypeSchema: z.ZodEnum<["ADMINISTRATIVE_FEE", "BOOKING_FEE", "CLEANING_FEE", "DOCK_FEE", "GUEST_REGISTRATION", "HOA_FEE", "HOTEL_TAX", "HOT_TUB_FEE", "MANAGEMENT_FEE", "MISCELLANEOUS_FEE", "OCCUPANCY_TAX", "PARKING_FEE", "PER_EXTRA_PERSON_FEE", "POOL_FEE", "POOL_HEATING_FEE", "RESORT_FEE", "SECURITY_DEPOSIT_FEE", "SERVICE_FEE", "UTILITY_FEE", "VAT_TAX", "WAIVER_DAMAGE_FEE", "PET_FEE"]>;
+export declare const BookingDotComFeeTypeSchema: z.ZodEnum<["AIRPORT_SHUTTLE_FEE", "AIR_CONDITIONING_FEE", "CITY_TAX", "CLUB_CARD_FEE", "CONSERVATION_FEE", "CREDIT_CARD_FEE", "DESTINATION_FEE", "ELECTRICITY_FEE", "ENVIRONMENT_FEE", "FINAL_CLEANING_FEE", "GAS_FEE", "GOODS_AND_SERVICES_TAX", "GOVERNMENT_TAX", "HEATING_FEE", "HERITAGE_FEE", "HOT_SPRING_TAX", "HOUSEKEEPING_FEE", "KITCHEN_LINEN_FEE", "LINEN_FEE", "LINEN_PACKAGE_FEE", "LOCAL_COUNCIL_TAX", "MUNICIPALITY_FEE", "OIL_FEE", "PETS_FEE", "RESIDENTIAL_TAX", "RESORT_FEE", "SAUNA_FITNESS_FACILITIES_TAX", "SEA_PLANE_FEE", "SERVICE_CHARGE_FEE", "SHUTTLE_BOAT_FEE", "SKI_PASS_FEE", "SPA_TAX", "TOWEL_FEE", "TRANSFER_FEE", "TRANSIT_FEE", "VAT", "VISA_SUPPORT_FEE", "WATER_FEE", "WATER_PARK_FEE", "WOOD_FEE", "WRISTBAND_FEE"]>;
+export declare const AirbnbFeeTypeSchema: z.ZodEnum<["PASS_THROUGH_RESORT_FEE", "PASS_THROUGH_MANAGEMENT_FEE", "PASS_THROUGH_COMMUNITY_FEE", "PASS_THROUGH_LINEN_FEE", "PASS_THROUGH_ELECTRICITY_FEE", "PASS_THROUGH_WATER_FEE", "PASS_THROUGH_HEATING_FEE", "PASS_THROUGH_AIR_CONDITIONING_FEE", "PASS_THROUGH_UTILITY_FEE", "PASS_THROUGH_PET_FEE", "PASS_THROUGH_CLEANING_FEE", "PASS_THROUGH_SHORT_TERM_CLEANING_FEE", "PASS_THROUGH_SECURITY_DEPOSIT", "PASS_THROUGH_HOTEL_TAX", "PASS_THROUGH_LODGING_TAX", "PASS_THROUGH_ROOM_TAX", "PASS_THROUGH_TOURIST_TAX", "PASS_THROUGH_TRANSIENT_OCCUPANCY_TAX", "PASS_THROUGH_SALES_TAX", "PASS_THROUGH_VAT_TAX", "PASS_THROUGH_TOURISM_ASSESSMENT_FEE", "AIRBNB_COLLECTED_TAX"]>;
+export declare const AirbnbFeeUnitTypeSchema: z.ZodEnum<["PER_CUBIC_METER", "PER_KILOWATT_HOUR", "PER_LITER"]>;

package/dist/src/enums.js

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AirbnbFeeUnitTypeSchema = exports.AirbnbFeeTypeSchema = exports.BookingDotComFeeTypeSchema = exports.MarriottFeeTypeSchema = exports.VrboFeeTypeSchema = exports.LeadStatusSchema = void 0;
+const zod_1 = require("zod");
+exports.LeadStatusSchema = zod_1.z.enum([
+    "BLOCKED",
+    "NEW",
+    "ON_HOLD",
+    "CLOSED",
+    "PENDING",
+    "DECLINED",
+    "BOOKED",
+    "CANCELLED",
+    "IGNORED",
+    "DUPLICATE",
+    "SAMPLE",
+]);
+exports.VrboFeeTypeSchema = zod_1.z.enum([
+    "ADDITIONAL_BED",
+    "ADMINISTRATIVE",
+    "AIR_CONDITIONING",
+    "ARRIVAL_EARLY",
+    "ARRIVAL_LATE",
+    "ASSOCIATION_PROPERTY",
+    "BABY_BED",
+    "BOOKING_EARLY",
+    "BOOKING_LATE",
+    "CLASS",
+    "CLUB",
+    "CONCIERGE",
+    "DEPARTURE_EARLY",
+    "DEPARTURE_LATE",
+    "ELECTRICITY",
+    "EQUIPMENT",
+    "FOOD",
+    "GARDENING",
+    "GAS",
+    "HEATING",
+    "HIGH_CHAIR",
+    "HOT_TUB",
+    "INTERNET",
+    "LABOR",
+    "LAUNDRY",
+    "LINENS",
+    "LINENS_BATH",
+    "LINENS_BED",
+    "MANAGEMENT",
+    "OIL",
+    "ON_SITE_PAYMENT_METHOD",
+    "PARKING",
+    "PET",
+    "PHONE",
+    "POOL",
+    "POOL_HEATING",
+    "RENT",
+    "RESORT",
+    "SPA",
+    "TAX",
+    "TOILETRIES",
+    "TOUR",
+    "TRANSPORTATION",
+    "UTENSILS_CLEANING",
+    "UTENSILS_FOOD",
+    "VEHICLE",
+    "WAIVER_DAMAGE",
+    "WATER",
+    "WATER_CRAFT",
+    "WATER_CRAFT_MOORING",
+    "WATER_DRINKING",
+    "WOOD",
+]);
+exports.MarriottFeeTypeSchema = zod_1.z.enum([
+    "ADMINISTRATIVE_FEE",
+    "BOOKING_FEE",
+    "CLEANING_FEE",
+    "DOCK_FEE",
+    "GUEST_REGISTRATION",
+    "HOA_FEE",
+    "HOTEL_TAX",
+    "HOT_TUB_FEE",
+    "MANAGEMENT_FEE",
+    "MISCELLANEOUS_FEE",
+    "OCCUPANCY_TAX",
+    "PARKING_FEE",
+    "PER_EXTRA_PERSON_FEE",
+    "POOL_FEE",
+    "POOL_HEATING_FEE",
+    "RESORT_FEE",
+    "SECURITY_DEPOSIT_FEE",
+    "SERVICE_FEE",
+    "UTILITY_FEE",
+    "VAT_TAX",
+    "WAIVER_DAMAGE_FEE",
+    "PET_FEE",
+]);
+exports.BookingDotComFeeTypeSchema = zod_1.z.enum([
+    "AIRPORT_SHUTTLE_FEE",
+    "AIR_CONDITIONING_FEE",
+    "CITY_TAX",
+    "CLUB_CARD_FEE",
+    "CONSERVATION_FEE",
+    "CREDIT_CARD_FEE",
+    "DESTINATION_FEE",
+    "ELECTRICITY_FEE",
+    "ENVIRONMENT_FEE",
+    "FINAL_CLEANING_FEE",
+    "GAS_FEE",
+    "GOODS_AND_SERVICES_TAX",
+    "GOVERNMENT_TAX",
+    "HEATING_FEE",
+    "HERITAGE_FEE",
+    "HOT_SPRING_TAX",
+    "HOUSEKEEPING_FEE",
+    "KITCHEN_LINEN_FEE",
+    "LINEN_FEE",
+    "LINEN_PACKAGE_FEE",
+    "LOCAL_COUNCIL_TAX",
+    "MUNICIPALITY_FEE",
+    "OIL_FEE",
+    "PETS_FEE",
+    "RESIDENTIAL_TAX",
+    "RESORT_FEE",
+    "SAUNA_FITNESS_FACILITIES_TAX",
+    "SEA_PLANE_FEE",
+    "SERVICE_CHARGE_FEE",
+    "SHUTTLE_BOAT_FEE",
+    "SKI_PASS_FEE",
+    "SPA_TAX",
+    "TOWEL_FEE",
+    "TRANSFER_FEE",
+    "TRANSIT_FEE",
+    "VAT",
+    "VISA_SUPPORT_FEE",
+    "WATER_FEE",
+    "WATER_PARK_FEE",
+    "WOOD_FEE",
+    "WRISTBAND_FEE",
+]);
+exports.AirbnbFeeTypeSchema = zod_1.z.enum([
+    "PASS_THROUGH_RESORT_FEE",
+    "PASS_THROUGH_MANAGEMENT_FEE",
+    "PASS_THROUGH_COMMUNITY_FEE",
+    "PASS_THROUGH_LINEN_FEE",
+    "PASS_THROUGH_ELECTRICITY_FEE",
+    "PASS_THROUGH_WATER_FEE",
+    "PASS_THROUGH_HEATING_FEE",
+    "PASS_THROUGH_AIR_CONDITIONING_FEE",
+    "PASS_THROUGH_UTILITY_FEE",
+    "PASS_THROUGH_PET_FEE",
+    "PASS_THROUGH_CLEANING_FEE",
+    "PASS_THROUGH_SHORT_TERM_CLEANING_FEE",
+    "PASS_THROUGH_SECURITY_DEPOSIT",
+    "PASS_THROUGH_HOTEL_TAX",
+    "PASS_THROUGH_LODGING_TAX",
+    "PASS_THROUGH_ROOM_TAX",
+    "PASS_THROUGH_TOURIST_TAX",
+    "PASS_THROUGH_TRANSIENT_OCCUPANCY_TAX",
+    "PASS_THROUGH_SALES_TAX",
+    "PASS_THROUGH_VAT_TAX",
+    "PASS_THROUGH_TOURISM_ASSESSMENT_FEE",
+    "AIRBNB_COLLECTED_TAX",
+]);
+exports.AirbnbFeeUnitTypeSchema = zod_1.z.enum([
+    "PER_CUBIC_METER",
+    "PER_KILOWATT_HOUR",
+    "PER_LITER",
+]);

package/dist/src/index.d.ts

@@ -0,0 +1,12 @@
+export * from "./HostfullyApi";
+export * from "./PropertiesApi";
+export * from "./FeesApi";
+export * from "./PricingApi";
+export * from "./LeadsApi";
+export * from "./MessagesApi";
+export * from "./AgenciesApi";
+export * from "./pagination";
+export * from "./OrderApi";
+export * from "./Transport";
+export * from "./FetchTransport";
+export * from "./AmenitiesApi";

package/dist/src/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./HostfullyApi"), exports);
+__exportStar(require("./PropertiesApi"), exports);
+__exportStar(require("./FeesApi"), exports);
+__exportStar(require("./PricingApi"), exports);
+__exportStar(require("./LeadsApi"), exports);
+__exportStar(require("./MessagesApi"), exports);
+__exportStar(require("./AgenciesApi"), exports);
+__exportStar(require("./pagination"), exports);
+__exportStar(require("./OrderApi"), exports);
+__exportStar(require("./Transport"), exports);
+__exportStar(require("./FetchTransport"), exports);
+__exportStar(require("./AmenitiesApi"), exports);

package/dist/src/pagination.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+export declare const PagingSchema: z.ZodObject<{
+    _limit: z.ZodNumber;
+    _nextCursor: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    _limit: number;
+    _nextCursor: string | null;
+}, {
+    _limit: number;
+    _nextCursor: string | null;
+}>;
+export type Paging = z.infer<typeof PagingSchema>;
+export declare function scan<Result extends {
+    _paging: Paging;
+}>(fn: (cursor: string | undefined) => Promise<Result>): AsyncGenerator<Result, void, unknown>;

package/dist/src/pagination.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PagingSchema = void 0;
+exports.scan = scan;
+const zod_1 = require("zod");
+exports.PagingSchema = zod_1.z.object({
+    _limit: zod_1.z.number(),
+    _nextCursor: zod_1.z.string().nullable(),
+});
+async function* scan(fn) {
+    let cursor = undefined;
+    let done = false;
+    while (!done) {
+        const result = await fn(cursor ?? undefined);
+        yield result;
+        cursor = result._paging._nextCursor;
+        done = cursor == null;
+    }
+}