@novu/api 0.0.1-alpha.9 → 0.0.1-alpha.92

package/src/sdk/webhooks.ts

@@ -1,138 +1,27 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { SDKHooks } from "../hooks/hooks.js";
-import { SDK_METADATA, SDKOptions, serverURLFromOptions } from "../lib/config.js";
-import { encodeSimple as encodeSimple$ } from "../lib/encodings.js";
-import { HTTPClient } from "../lib/http.js";
-import * as retries$ from "../lib/retries.js";
-import * as schemas$ from "../lib/schemas.js";
+import { integrationsWebhooksRetrieve } from "../funcs/integrationsWebhooksRetrieve.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
-import * as z from "zod";
+import { unwrapAsync } from "../types/fp.js";
 
 export class Webhooks extends ClientSDK {
-    private readonly options$: SDKOptions & { hooks?: SDKHooks };
-
-    constructor(options: SDKOptions = {}) {
-        const opt = options as unknown;
-        let hooks: SDKHooks;
-        if (
-            typeof opt === "object" &&
-            opt != null &&
-            "hooks" in opt &&
-            opt.hooks instanceof SDKHooks
-        ) {
-            hooks = opt.hooks;
-        } else {
-            hooks = new SDKHooks();
-        }
-
-        super({
-            client: options.httpClient || new HTTPClient(),
-            baseURL: serverURLFromOptions(options),
-            hooks,
-        });
-
-        this.options$ = { ...options, hooks };
-        void this.options$;
-    }
-
-    /**
-     * Get webhook support status for provider
-     *
-     * @remarks
-     * Return the status of the webhook for this provider, if it is supported or if it is not based on a boolean value
-     */
-    async retrieve(
-        providerOrIntegrationId: string,
-        options?: RequestOptions & { retries?: retries$.RetryConfig }
-    ): Promise<boolean> {
-        const input$: operations.IntegrationsControllerGetWebhookSupportStatusRequest = {
-            providerOrIntegrationId: providerOrIntegrationId,
-        };
-        const headers$ = new Headers();
-        headers$.set("user-agent", SDK_METADATA.userAgent);
-        headers$.set("Accept", "application/json");
-
-        const payload$ = schemas$.parse(
-            input$,
-            (value$) =>
-                operations.IntegrationsControllerGetWebhookSupportStatusRequest$.outboundSchema.parse(
-                    value$
-                ),
-            "Input validation failed"
-        );
-        const body$ = null;
-
-        const pathParams$ = {
-            providerOrIntegrationId: encodeSimple$(
-                "providerOrIntegrationId",
-                payload$.providerOrIntegrationId,
-                { explode: false, charEncoding: "percent" }
-            ),
-        };
-        const path$ = this.templateURLComponent(
-            "/v1/integrations/webhook/provider/{providerOrIntegrationId}/status"
-        )(pathParams$);
-
-        const query$ = "";
-
-        let security$;
-        if (typeof this.options$.apiKey === "function") {
-            security$ = { apiKey: await this.options$.apiKey() };
-        } else if (this.options$.apiKey) {
-            security$ = { apiKey: this.options$.apiKey };
-        } else {
-            security$ = {};
-        }
-        const context = {
-            operationID: "IntegrationsController_getWebhookSupportStatus",
-            oAuth2Scopes: [],
-            securitySource: this.options$.apiKey,
-        };
-        const securitySettings$ = this.resolveGlobalSecurity(security$);
-
-        const doOptions = { context, errorCodes: ["409", "429", "4XX", "503", "5XX"] };
-        const request$ = this.createRequest$(
-            context,
-            {
-                security: securitySettings$,
-                method: "GET",
-                path: path$,
-                headers: headers$,
-                query: query$,
-                body: body$,
-            },
-            options
-        );
-
-        const retryConfig = options?.retries ||
-            this.options$.retryConfig || {
-                strategy: "backoff",
-                backoff: {
-                    initialInterval: 500,
-                    maxInterval: 30000,
-                    exponent: 1.5,
-                    maxElapsedTime: 3600000,
-                },
-                retryConnectionErrors: true,
-            };
-
-        const response = await retries$.retry(
-            () => {
-                const cloned = request$.clone();
-                return this.do$(cloned, doOptions);
-            },
-            { config: retryConfig, statusCodes: ["408", "409", "429", "5XX"] }
-        );
-
-        const [result$] = await this.matcher<boolean>()
-            .json(200, z.boolean())
-            .fail([409, 429, "4XX", 503, "5XX"])
-            .match(response);
-
-        return result$;
-    }
+  /**
+   * Get webhook support status for provider
+   *
+   * @remarks
+   * Return the status of the webhook for this provider, if it is supported or if it is not based on a boolean value
+   */
+  async retrieve(
+    providerOrIntegrationId: string,
+    options?: RequestOptions,
+  ): Promise<operations.IntegrationsControllerGetWebhookSupportStatusResponse> {
+    return unwrapAsync(integrationsWebhooksRetrieve(
+      this,
+      providerOrIntegrationId,
+      options,
+    ));
+  }
 }

package/src/types/blobs.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";

package/src/types/constdatetime.ts

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export function constDateTime(
+  val: string,
+): z.ZodType<string, z.ZodTypeDef, unknown> {
+  return z.custom<string>((v) => {
+    return (
+      typeof v === "string" && new Date(v).getTime() === new Date(val).getTime()
+    );
+  }, `Value must be equivelant to ${val}`);
+}

package/src/types/enums.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 declare const __brand: unique symbol;

package/src/types/fp.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * A monad that captures the result of a function call or an error if it was not
+ * successful. Railway programming, enabled by this type, can be a nicer
+ * alternative to traditional exception throwing because it allows functions to
+ * declare all _known_ errors with static types and then check for them
+ * exhaustively in application code. Thrown exception have a type of `unknown`
+ * and break out of regular control flow of programs making them harder to
+ * inspect and more verbose work with due to try-catch blocks.
+ */
+export type Result<T, E = unknown> =
+  | { ok: true; value: T; error?: never }
+  | { ok: false; value?: never; error: E };
+
+export function OK<V>(value: V): Result<V, never> {
+  return { ok: true, value };
+}
+
+export function ERR<E>(error: E): Result<never, E> {
+  return { ok: false, error };
+}
+
+/**
+ * unwrap is a convenience function for extracting a value from a result or
+ * throwing if there was an error.
+ */
+export function unwrap<T>(r: Result<T, unknown>): T {
+  if (!r.ok) {
+    throw r.error;
+  }
+  return r.value;
+}
+
+/**
+ * unwrapAsync is a convenience function for resolving a value from a Promise
+ * of a result or rejecting if an error occurred.
+ */
+export async function unwrapAsync<T>(
+  pr: Promise<Result<T, unknown>>,
+): Promise<T> {
+  const r = await pr;
+  if (!r.ok) {
+    throw r.error;
+  }
+
+  return r.value;
+}

package/src/types/index.ts

@@ -1,10 +1,11 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export { RFCDate } from "./rfcdate.js";
 export { blobLikeSchema, isBlobLike } from "./blobs.js";
-export type { Paginator, PageIterator } from "./operations.js";
-export { createPageIterator } from "./operations.js";
 export { catchUnrecognizedEnum } from "./enums.js";
-export type { OpenEnum, ClosedEnum, Unrecognized } from "./enums.js";
+export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js";
+export type { Result } from "./fp.js";
+export type { PageIterator, Paginator } from "./operations.js";
+export { createPageIterator } from "./operations.js";
+export { RFCDate } from "./rfcdate.js";

package/src/types/operations.ts

@@ -1,25 +1,105 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export type Paginator<Result> = () => Promise<PageIterator<Result>> | null;
+import { Result } from "./fp.js";
 
-export type PageIterator<Result> = Result & {
-  next: Paginator<Result>;
-  [Symbol.asyncIterator]: () => AsyncIterableIterator<Result>;
+export type Paginator<V> = () => Promise<V & { next: Paginator<V> }> | null;
+
+export type PageIterator<V, PageState = unknown> = V & {
+  next: Paginator<V>;
+  [Symbol.asyncIterator]: () => AsyncIterableIterator<V>;
+  "~next"?: PageState | undefined;
 };
 
-export function createPageIterator<Result>(
-  page: Result & { next: Paginator<Result> },
-): { [Symbol.asyncIterator]: () => AsyncIterableIterator<Result> } {
+export function createPageIterator<V>(
+  page: V & { next: Paginator<V> },
+  halt: (v: V) => boolean,
+): {
+  [Symbol.asyncIterator]: () => AsyncIterableIterator<V>;
+} {
   return {
     [Symbol.asyncIterator]: async function* paginator() {
       yield page;
+      if (halt(page)) {
+        return;
+      }
 
       let p: typeof page | null = page;
       for (p = await p.next(); p != null; p = await p.next()) {
         yield p;
+        if (halt(p)) {
+          return;
+        }
+      }
+    },
+  };
+}
+
+/**
+ * This utility create a special iterator that yields a single value and
+ * 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, undefined> {
+  return {
+    ...v,
+    next: () => null,
+    [Symbol.asyncIterator]: async function* paginator() {
+      yield 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, PageState>(
+  iteratorPromise: Promise<PageIterator<Result<V, unknown>, PageState>>,
+): Promise<PageIterator<V, PageState>> {
+  const resultIter = await iteratorPromise;
+
+  if (!resultIter.ok) {
+    throw resultIter.error;
+  }
+
+  return {
+    ...resultIter.value,
+    next: unwrapPaginator(resultIter.next),
+    "~next": resultIter["~next"],
+    [Symbol.asyncIterator]: async function* paginator() {
+      for await (const page of resultIter) {
+        if (!page.ok) {
+          throw page.error;
+        }
+        yield page.value;
       }
     },
   };
 }
+
+function unwrapPaginator<V>(
+  paginator: Paginator<Result<V, unknown>>,
+): Paginator<V> {
+  return () => {
+    const nextResult = paginator();
+    if (nextResult == null) {
+      return null;
+    }
+    return nextResult.then((res) => {
+      if (!res.ok) {
+        throw res.error;
+      }
+      const out = {
+        ...res.value,
+        next: unwrapPaginator(res.next),
+      };
+      return out;
+    });
+  };
+}
+
+export const URL_OVERRIDE = Symbol("URL_OVERRIDE");

package/src/types/rfcdate.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 const dateRE = /^\d{4}-\d{2}-\d{2}$/;

package/src/types/streams.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export function isReadableStream<T = Uint8Array>(
+  val: unknown,
+): val is ReadableStream<T> {
+  if (typeof val !== "object" || val === null) {
+    return false;
+  }
+
+  // Check for the presence of methods specific to ReadableStream
+  const stream = val as ReadableStream<Uint8Array>;
+
+  // ReadableStream has methods like getReader, cancel, and tee
+  return (
+    typeof stream.getReader === "function" &&
+    typeof stream.cancel === "function" &&
+    typeof stream.tee === "function"
+  );
+}

package/types/blobs.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;

package/types/constdatetime.d.ts

@@ -0,0 +1,3 @@
+import * as z from "zod";
+export declare function constDateTime(val: string): z.ZodType<string, z.ZodTypeDef, unknown>;
+//# sourceMappingURL=constdatetime.d.ts.map

package/types/constdatetime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constdatetime.d.ts","sourceRoot":"","sources":["../src/types/constdatetime.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,wBAAgB,aAAa,CAC3B,GAAG,EAAE,MAAM,GACV,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,CAM1C"}

package/{models/components/messagetemplatedto.js → types/constdatetime.js}

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -26,12 +26,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageTemplateDto$ = void 0;
+exports.constDateTime = void 0;
 const z = __importStar(require("zod"));
-/** @internal */
-var MessageTemplateDto$;
-(function (MessageTemplateDto$) {
-    MessageTemplateDto$.inboundSchema = z.object({});
-    MessageTemplateDto$.outboundSchema = z.object({});
-})(MessageTemplateDto$ || (exports.MessageTemplateDto$ = MessageTemplateDto$ = {}));
-//# sourceMappingURL=messagetemplatedto.js.map
+function constDateTime(val) {
+    return z.custom((v) => {
+        return (typeof v === "string" && new Date(v).getTime() === new Date(val).getTime());
+    }, `Value must be equivelant to ${val}`);
+}
+exports.constDateTime = constDateTime;
+//# sourceMappingURL=constdatetime.js.map

package/types/constdatetime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constdatetime.js","sourceRoot":"","sources":["../src/types/constdatetime.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAEzB,SAAgB,aAAa,CAC3B,GAAW;IAEX,OAAO,CAAC,CAAC,MAAM,CAAS,CAAC,CAAC,EAAE,EAAE;QAC5B,OAAO,CACL,OAAO,CAAC,KAAK,QAAQ,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAC3E,CAAC;IACJ,CAAC,EAAE,+BAA+B,GAAG,EAAE,CAAC,CAAC;AAC3C,CAAC;AARD,sCAQC"}

package/types/enums.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.catchUnrecognizedEnum = void 0;

package/types/fp.d.ts

@@ -0,0 +1,31 @@
+/**
+ * A monad that captures the result of a function call or an error if it was not
+ * successful. Railway programming, enabled by this type, can be a nicer
+ * alternative to traditional exception throwing because it allows functions to
+ * declare all _known_ errors with static types and then check for them
+ * exhaustively in application code. Thrown exception have a type of `unknown`
+ * and break out of regular control flow of programs making them harder to
+ * inspect and more verbose work with due to try-catch blocks.
+ */
+export type Result<T, E = unknown> = {
+    ok: true;
+    value: T;
+    error?: never;
+} | {
+    ok: false;
+    value?: never;
+    error: E;
+};
+export declare function OK<V>(value: V): Result<V, never>;
+export declare function ERR<E>(error: E): Result<never, E>;
+/**
+ * unwrap is a convenience function for extracting a value from a result or
+ * throwing if there was an error.
+ */
+export declare function unwrap<T>(r: Result<T, unknown>): T;
+/**
+ * unwrapAsync is a convenience function for resolving a value from a Promise
+ * of a result or rejecting if an error occurred.
+ */
+export declare function unwrapAsync<T>(pr: Promise<Result<T, unknown>>): Promise<T>;
+//# sourceMappingURL=fp.d.ts.map

package/types/fp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fp.d.ts","sourceRoot":"","sources":["../src/types/fp.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,OAAO,IAC7B;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GACrC;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAE3C,wBAAgB,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAEhD;AAED,wBAAgB,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAEjD;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAKlD;AAED;;;GAGG;AACH,wBAAsB,WAAW,CAAC,CAAC,EACjC,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,GAC9B,OAAO,CAAC,CAAC,CAAC,CAOZ"}

package/types/fp.js

@@ -0,0 +1,38 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unwrapAsync = exports.unwrap = exports.ERR = exports.OK = void 0;
+function OK(value) {
+    return { ok: true, value };
+}
+exports.OK = OK;
+function ERR(error) {
+    return { ok: false, error };
+}
+exports.ERR = ERR;
+/**
+ * unwrap is a convenience function for extracting a value from a result or
+ * throwing if there was an error.
+ */
+function unwrap(r) {
+    if (!r.ok) {
+        throw r.error;
+    }
+    return r.value;
+}
+exports.unwrap = unwrap;
+/**
+ * unwrapAsync is a convenience function for resolving a value from a Promise
+ * of a result or rejecting if an error occurred.
+ */
+async function unwrapAsync(pr) {
+    const r = await pr;
+    if (!r.ok) {
+        throw r.error;
+    }
+    return r.value;
+}
+exports.unwrapAsync = unwrapAsync;
+//# sourceMappingURL=fp.js.map

package/types/fp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fp.js","sourceRoot":"","sources":["../src/types/fp.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAeH,SAAgB,EAAE,CAAI,KAAQ;IAC5B,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAC7B,CAAC;AAFD,gBAEC;AAED,SAAgB,GAAG,CAAI,KAAQ;IAC7B,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AAC9B,CAAC;AAFD,kBAEC;AAED;;;GAGG;AACH,SAAgB,MAAM,CAAI,CAAqB;IAC7C,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACV,MAAM,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IACD,OAAO,CAAC,CAAC,KAAK,CAAC;AACjB,CAAC;AALD,wBAKC;AAED;;;GAGG;AACI,KAAK,UAAU,WAAW,CAC/B,EAA+B;IAE/B,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;IACnB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACV,MAAM,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAED,OAAO,CAAC,CAAC,KAAK,CAAC;AACjB,CAAC;AATD,kCASC"}

package/types/index.d.ts

@@ -1,7 +1,8 @@
-export { RFCDate } from "./rfcdate.js";
 export { blobLikeSchema, isBlobLike } from "./blobs.js";
-export type { Paginator, PageIterator } from "./operations.js";
-export { createPageIterator } from "./operations.js";
 export { catchUnrecognizedEnum } from "./enums.js";
-export type { OpenEnum, ClosedEnum, Unrecognized } from "./enums.js";
+export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js";
+export type { Result } from "./fp.js";
+export type { PageIterator, Paginator } from "./operations.js";
+export { createPageIterator } from "./operations.js";
+export { RFCDate } from "./rfcdate.js";
 //# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/types/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxD,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/types/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrE,YAAY,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}

package/types/index.js

@@ -1,16 +1,16 @@
 "use strict";
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.catchUnrecognizedEnum = exports.createPageIterator = exports.isBlobLike = exports.blobLikeSchema = exports.RFCDate = void 0;
-var rfcdate_js_1 = require("./rfcdate.js");
-Object.defineProperty(exports, "RFCDate", { enumerable: true, get: function () { return rfcdate_js_1.RFCDate; } });
+exports.RFCDate = exports.createPageIterator = exports.catchUnrecognizedEnum = exports.isBlobLike = exports.blobLikeSchema = void 0;
 var blobs_js_1 = require("./blobs.js");
 Object.defineProperty(exports, "blobLikeSchema", { enumerable: true, get: function () { return blobs_js_1.blobLikeSchema; } });
 Object.defineProperty(exports, "isBlobLike", { enumerable: true, get: function () { return blobs_js_1.isBlobLike; } });
-var operations_js_1 = require("./operations.js");
-Object.defineProperty(exports, "createPageIterator", { enumerable: true, get: function () { return operations_js_1.createPageIterator; } });
 var enums_js_1 = require("./enums.js");
 Object.defineProperty(exports, "catchUnrecognizedEnum", { enumerable: true, get: function () { return enums_js_1.catchUnrecognizedEnum; } });
+var operations_js_1 = require("./operations.js");
+Object.defineProperty(exports, "createPageIterator", { enumerable: true, get: function () { return operations_js_1.createPageIterator; } });
+var rfcdate_js_1 = require("./rfcdate.js");
+Object.defineProperty(exports, "RFCDate", { enumerable: true, get: function () { return rfcdate_js_1.RFCDate; } });
 //# sourceMappingURL=index.js.map

package/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/types/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,2CAAuC;AAA9B,qGAAA,OAAO,OAAA;AAChB,uCAAwD;AAA/C,0GAAA,cAAc,OAAA;AAAE,sGAAA,UAAU,OAAA;AAEnC,iDAAqD;AAA5C,mHAAA,kBAAkB,OAAA;AAC3B,uCAAmD;AAA1C,iHAAA,qBAAqB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/types/index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,uCAAwD;AAA/C,0GAAA,cAAc,OAAA;AAAE,sGAAA,UAAU,OAAA;AACnC,uCAAmD;AAA1C,iHAAA,qBAAqB,OAAA;AAI9B,iDAAqD;AAA5C,mHAAA,kBAAkB,OAAA;AAC3B,2CAAuC;AAA9B,qGAAA,OAAO,OAAA"}

package/types/operations.d.ts

@@ -1,11 +1,27 @@
-export type Paginator<Result> = () => Promise<PageIterator<Result>> | null;
-export type PageIterator<Result> = Result & {
-    next: Paginator<Result>;
-    [Symbol.asyncIterator]: () => AsyncIterableIterator<Result>;
+import { Result } from "./fp.js";
+export type Paginator<V> = () => Promise<V & {
+    next: Paginator<V>;
+}> | null;
+export type PageIterator<V, PageState = unknown> = V & {
+    next: Paginator<V>;
+    [Symbol.asyncIterator]: () => AsyncIterableIterator<V>;
+    "~next"?: PageState | undefined;
 };
-export declare function createPageIterator<Result>(page: Result & {
-    next: Paginator<Result>;
-}): {
-    [Symbol.asyncIterator]: () => AsyncIterableIterator<Result>;
+export declare function createPageIterator<V>(page: V & {
+    next: Paginator<V>;
+}, halt: (v: V) => boolean): {
+    [Symbol.asyncIterator]: () => AsyncIterableIterator<V>;
 };
+/**
+ * This utility create a special iterator that yields a single value and
+ * terminates. It is useful in paginated SDK functions that have early return
+ * paths when things go wrong.
+ */
+export declare function haltIterator<V extends object>(v: V): PageIterator<V, undefined>;
+/**
+ * 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 declare function unwrapResultIterator<V, PageState>(iteratorPromise: Promise<PageIterator<Result<V, unknown>, PageState>>): Promise<PageIterator<V, PageState>>;
+export declare const URL_OVERRIDE: unique symbol;
 //# sourceMappingURL=operations.d.ts.map

package/types/operations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../src/types/operations.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,SAAS,CAAC,MAAM,IAAI,MAAM,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC;AAE3E,MAAM,MAAM,YAAY,CAAC,MAAM,IAAI,MAAM,GAAG;IAC1C,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,MAAM,qBAAqB,CAAC,MAAM,CAAC,CAAC;CAC7D,CAAC;AAEF,wBAAgB,kBAAkB,CAAC,MAAM,EACvC,IAAI,EAAE,MAAM,GAAG;IAAE,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,CAAA;CAAE,GACzC;IAAE,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,MAAM,qBAAqB,CAAC,MAAM,CAAC,CAAA;CAAE,CAWjE"}
+{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../src/types/operations.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,GAAG;IAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;CAAE,CAAC,GAAG,IAAI,CAAC;AAE5E,MAAM,MAAM,YAAY,CAAC,CAAC,EAAE,SAAS,GAAG,OAAO,IAAI,CAAC,GAAG;IACrD,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,MAAM,qBAAqB,CAAC,CAAC,CAAC,CAAC;IACvD,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,IAAI,EAAE,CAAC,GAAG;IAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;CAAE,EAChC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,GACtB;IACD,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,MAAM,qBAAqB,CAAC,CAAC,CAAC,CAAC;CACxD,CAiBA;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAC3C,CAAC,EAAE,CAAC,GACH,YAAY,CAAC,CAAC,EAAE,SAAS,CAAC,CAQ5B;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,CAAC,CAAC,EAAE,SAAS,EACrD,eAAe,EAAE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,GACpE,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAoBrC;AAuBD,eAAO,MAAM,YAAY,eAAyB,CAAC"}