@kontent-ai/core-sdk 12.0.0-preview.2 → 12.0.0-preview.21

package/dist/models/core.models.d.ts

@@ -1,5 +1,5 @@
-import type { CoreSdkError } from "./error.models.js";
-import type { PickStringLiteral } from "./utility.models.js";
+import type { ErrorDetailsFor, KontentSdkError } from "./error.models.js";
+import type { LiteralUnion, PickStringLiteral } from "./utility.types.js";
 /**
  * SDK info for identification of the SDK
  */
@@ -24,51 +24,56 @@ export type Header = {
     readonly value: string;
 };
 export type HttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
-export type KontentValidationError = {
+export type ValidationError = {
     readonly message: string;
     readonly path?: string;
     readonly line?: number;
     readonly position?: number;
 };
-export type KontentErrorResponseData = {
+export type ErrorResponseData = {
     readonly message: string;
-    readonly requestId?: string;
-    readonly error_code?: number;
-    readonly validation_errors?: readonly KontentValidationError[];
+    readonly request_id: string;
+    readonly error_code: number;
+    readonly validation_errors?: readonly ValidationError[];
 };
 export type RetryStrategyOptions = {
     /**
      * Maximum number of retry attempts.
      *
-     * If not provided, the default implementation will be used.
+     * If not provided, the default number of retries defined within the SDK will be used.
      */
     readonly maxRetries?: number;
     /**
-     * Function to determine if the error should be retried.
+     * Determines whether an adapter error should be retried.
      *
-     * If not provided, the default implementation will be used.
-     */
-    readonly canRetryError?: (error: CoreSdkError) => boolean;
-    /**
-     * Function to determine the delay between requests in milliseconds.
+     * Adapter errors occur when the HTTP adapter fails to execute the request
+     * (e.g. network failures, connection timeouts, or other transport-level issues).
+     *
+     * This callback is evaluated only after SDK-defined retry rules are checked.
+     * The SDK handles the following cases directly:
+     *
+     * - Retried automatically:
+     *   - HTTP 429 (rate limit exceeded)
+     *
+     * - Not retried automatically:
+     *   - Invalid request body (`invalidBody`)
+     *   - Invalid URL (`invalidUrl`)
+     *   - 404 Not Found (`notFound`)
+     *   - 401 Unauthorized (`unauthorized`)
+     *   - API business/validation error response (`kontentErrorResponse`)
      *
-     * If not provided, the default implementation will be used.
      */
-    readonly getDelayBetweenRetriesMs?: (error: CoreSdkError) => number;
+    readonly canRetryAdapterError?: (error: KontentSdkError<ErrorDetailsFor<"adapterError">>) => boolean;
     /**
-     * Whether to log the retry attempt.
+     * Controls logging for retry attempts.
      *
-     * If false, the retry attempt will not be logged.
-     * If undefined, the default implementation will be used.
-     * Otherwise, the function will be called with the retry attempt and url.
+     * If undefined, no retry logging occurs (default behavior).
+     * If set to `'logToConsole'`, retries are logged to the console.
+     * If a function is provided, it is called with the retry attempt and url.
      */
-    readonly logRetryAttempt?: false | ((retryAttempt: number, url: string) => void);
+    readonly logRetryAttempt?: "logToConsole" | ((retryAttempt: number, url: string) => void);
+};
+export type ResolvedRetryStrategyOptions = Pick<Required<RetryStrategyOptions>, "maxRetries" | "canRetryAdapterError"> & {
+    readonly logRetryAttempt: undefined | ((retryAttempt: number, url: string) => void);
+    readonly getDelayBetweenRetriesMs: (error: KontentSdkError) => number;
 };
-/**
- * Adds intellisense for string union type, but also allows any string
- */
-export type LiteralUnion<T extends string | undefined> = T | (string & NonNullable<unknown>);
-/**
- * Adds intellisense for number union type, but also allows any number
- */
-export type LiteralUnionNumber<T extends number | undefined> = T | (number & NonNullable<unknown>);

package/dist/models/error.models.d.ts

@@ -1,30 +1,16 @@
 import type { ZodError } from "zod";
-import type { AdapterResponse, HttpServiceStatus } from "../http/http.models.js";
+import type { AdapterPayload, AdapterResponse, HttpPayload, HttpRequestBody } from "../http/http.models.js";
 import type { SuccessfulHttpResponse } from "../sdk/sdk-models.js";
-import type { KontentErrorResponseData, RetryStrategyOptions } from "./core.models.js";
-import type { JsonValue } from "./json.models.js";
-export type ErrorReason = "invalidResponse" | "invalidUrl" | "unknown" | "invalidBody" | "notFound" | "validationFailed" | "noResponses";
-export type CoreSdkErrorDetails<TReason extends ErrorReason = ErrorReason> = (Details<"invalidResponse", {
-    readonly kontentErrorResponse: KontentErrorResponseData | undefined;
-} & Pick<AdapterResponse<HttpServiceStatus>, "isValidResponse" | "responseHeaders" | "status" | "statusText">> | Details<"notFound", {
-    readonly kontentErrorResponse: KontentErrorResponseData | undefined;
-} & Pick<AdapterResponse<404>, "isValidResponse" | "responseHeaders" | "status" | "statusText">> | Details<"invalidBody", {
-    readonly originalError: unknown;
-}> | Details<"invalidUrl", {
-    readonly originalError: unknown;
-}> | Details<"unknown", {
-    readonly originalError: unknown;
-}> | Details<"validationFailed", {
-    readonly reason: "validationFailed";
+import type { ErrorResponseData, ResolvedRetryStrategyOptions } from "./core.models.js";
+export type ErrorReason = ErrorDetails["reason"];
+export type ErrorDetails = ReasonData<"adapterError", ErrorWithOriginalError> | ReasonData<"unauthorized", ErrorWithKontentResponse> | ReasonData<"invalidResponse", ErrorWithKontentResponse> | ReasonData<"parseError", ErrorWithOriginalError> | ReasonData<"notFound", ErrorWithKontentResponse> | ReasonData<"invalidBody", ErrorWithOriginalError> | ReasonData<"invalidUrl", ErrorWithOriginalError> | ReasonData<"aborted", ErrorWithOriginalError> | ReasonData<"validationFailed", {
     readonly zodError: ZodError;
-    readonly response: SuccessfulHttpResponse<JsonValue, JsonValue>;
+    readonly response: SuccessfulHttpResponse<HttpPayload, HttpRequestBody>;
     readonly url: string;
-}> | Details<"noResponses", {
+}> | ReasonData<"noResponses", {
     readonly url: string;
-}>) & {
-    readonly reason: TReason;
-};
-export type CoreSdkError<TReason extends ErrorReason = ErrorReason> = {
+}>;
+export interface BaseErrorData {
     /**
      * The message of the error
      */
@@ -36,13 +22,48 @@ export type CoreSdkError<TReason extends ErrorReason = ErrorReason> = {
     /**
      * Used retry strategy.
      */
-    readonly retryStrategyOptions?: Required<RetryStrategyOptions>;
+    readonly retryStrategyOptions: ResolvedRetryStrategyOptions | undefined;
     /**
      * The number of times the request has been retried.
      */
-    readonly retryAttempt?: number;
-} & CoreSdkErrorDetails<TReason>;
-type Details<TReason extends ErrorReason, TDetails> = {
+    readonly retryAttempt: number | undefined;
+}
+export declare class KontentSdkError<TDetails extends ErrorDetails = ErrorDetails> extends Error implements BaseErrorData {
+    readonly details: TDetails;
+    readonly url: string;
+    readonly retryStrategyOptions: ResolvedRetryStrategyOptions | undefined;
+    readonly retryAttempt: number | undefined;
+    constructor({ baseErrorData: { message, url, retryStrategyOptions, retryAttempt }, details, }: {
+        readonly baseErrorData: BaseErrorData;
+        readonly details: TDetails;
+    });
+}
+/**
+ * Http adapter should throw this error when the request is aborted.
+ *
+ * The error is then handled by the HttpService and converted to a KontentSdkError with the reason "aborted".
+ */
+export declare class AdapterAbortError extends Error {
+    constructor(error: unknown);
+}
+/**
+ * Http adapter should throw this error when the response is not valid JSON or BLOB.
+ *
+ * The error is then handled by the HttpService and converted to a KontentSdkError with the reason "parseError".
+ */
+export declare class AdapterParseError extends Error {
+    constructor(error: unknown);
+}
+export type ErrorDetailsFor<TReason extends ErrorReason> = Extract<ErrorDetails, {
+    readonly reason: TReason;
+}>;
+type ErrorWithKontentResponse = {
+    readonly kontentErrorResponse: ErrorResponseData | undefined;
+} & Pick<AdapterResponse<AdapterPayload>, "responseHeaders" | "status" | "statusText">;
+type ErrorWithOriginalError = {
+    readonly originalError: unknown;
+};
+type ReasonData<TReason extends ErrorReason, TData> = {
     readonly reason: TReason;
-} & TDetails;
+} & TData;
 export {};

package/dist/models/error.models.js

@@ -1,2 +1,41 @@
-export {};
+import { match, P } from "ts-pattern";
+export class KontentSdkError extends Error {
+    details;
+    url;
+    retryStrategyOptions;
+    retryAttempt;
+    constructor({ baseErrorData: { message, url, retryStrategyOptions, retryAttempt }, details, }) {
+        super(toFriendlyMessage(message, details));
+        this.url = url;
+        this.retryStrategyOptions = retryStrategyOptions;
+        this.retryAttempt = retryAttempt;
+        this.details = details;
+    }
+}
+/**
+ * Http adapter should throw this error when the request is aborted.
+ *
+ * The error is then handled by the HttpService and converted to a KontentSdkError with the reason "aborted".
+ */
+export class AdapterAbortError extends Error {
+    constructor(error) {
+        super(`Adapter has aborted the request. ${error instanceof Error ? error.message : "No details provided"}`, { cause: error });
+    }
+}
+/**
+ * Http adapter should throw this error when the response is not valid JSON or BLOB.
+ *
+ * The error is then handled by the HttpService and converted to a KontentSdkError with the reason "parseError".
+ */
+export class AdapterParseError extends Error {
+    constructor(error) {
+        super(`Adapter failed to parse the response. ${error instanceof Error ? error.message : "No details provided"}`, { cause: error });
+    }
+}
+function toFriendlyMessage(message, error) {
+    return match(error)
+        .returnType()
+        .with({ reason: P.union("invalidResponse", "notFound"), kontentErrorResponse: P.nonNullable }, (m) => `${message} ${m.kontentErrorResponse.message}`)
+        .otherwise(() => message);
+}
 //# sourceMappingURL=error.models.js.map

package/dist/models/error.models.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.models.js","sourceRoot":"","sources":["../../lib/models/error.models.ts"],"names":[],"mappings":""}
+{"version":3,"file":"error.models.js","sourceRoot":"","sources":["../../lib/models/error.models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,YAAY,CAAC;AAsDtC,MAAM,OAAO,eAA8D,SAAQ,KAAK;IAC9E,OAAO,CAAW;IAClB,GAAG,CAAS;IACZ,oBAAoB,CAA2C;IAC/D,YAAY,CAAqB;IAE1C,YAAY,EACX,aAAa,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,oBAAoB,EAAE,YAAY,EAAE,EACnE,OAAO,GAIP;QACA,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QAE3C,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACxB,CAAC;CACD;AAED;;;;GAIG;AACH,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAC3C,YAAY,KAAc;QACzB,KAAK,CAAC,oCAAoC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/H,CAAC;CACD;AAED;;;;GAIG;AACH,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAC3C,YAAY,KAAc;QACzB,KAAK,CAAC,yCAAyC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IACpI,CAAC;CACD;AAgBD,SAAS,iBAAiB,CAAC,OAAe,EAAE,KAAmB;IAC9D,OAAO,KAAK,CAAC,KAAK,CAAC;SACjB,UAAU,EAAU;SACpB,IAAI,CACJ,EAAE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,EAAE,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAC,CAAC,WAAW,EAAE,EACvF,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC,oBAAoB,CAAC,OAAO,EAAE,CACrD;SACA,SAAS,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC;AAC5B,CAAC"}

package/dist/models/json.models.d.ts

@@ -1,6 +1,15 @@
-import type { EmptyObject } from "./utility.models.js";
-export type JsonValue = string | number | null | boolean | JsonObject | JsonArray | EmptyObject;
-export interface JsonObject {
+import z from "zod";
+export type JsonValue = string | number | null | boolean | JsonObject | JsonArray;
+export type JsonObject = {
     readonly [property: string]: JsonValue;
-}
+};
 export type JsonArray = readonly JsonValue[];
+/**
+ * Runtime validator for the core SDK `JsonValue` type.
+ *
+ * Matches:
+ * - string | number | boolean | null
+ * - readonly JsonValue[]
+ * - { readonly [property: string]: JsonValue }
+ */
+export declare const jsonValueSchema: z.ZodType<JsonValue>;

package/dist/models/json.models.js

@@ -1,2 +1,11 @@
-export {};
+import z from "zod";
+/**
+ * Runtime validator for the core SDK `JsonValue` type.
+ *
+ * Matches:
+ * - string | number | boolean | null
+ * - readonly JsonValue[]
+ * - { readonly [property: string]: JsonValue }
+ */
+export const jsonValueSchema = z.lazy(() => z.union([z.string(), z.number(), z.boolean(), z.null(), z.array(jsonValueSchema).readonly(), z.record(z.string(), jsonValueSchema)]));
 //# sourceMappingURL=json.models.js.map

package/dist/models/json.models.js.map

@@ -1 +1 @@
-{"version":3,"file":"json.models.js","sourceRoot":"","sources":["../../lib/models/json.models.ts"],"names":[],"mappings":""}
+{"version":3,"file":"json.models.js","sourceRoot":"","sources":["../../lib/models/json.models.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AAUpB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,eAAe,GAAyB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAChE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,eAAe,CAAC,CAAC,CAAC,CACpI,CAAC"}

package/dist/models/utility.types.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Represents an empty object type.
+ */
+export type EmptyObject = Record<string, never>;
+/**
+ * Picks a string literal type from a union type.
+ */
+export type PickStringLiteral<T extends string, U extends T> = U;
+/**
+ * Adds intellisense for string union type, but also allows any string
+ */
+export type LiteralUnion<T extends string | undefined> = T | (string & NonNullable<unknown>);
+/**
+ * Adds intellisense for number union type, but also allows any number
+ */
+export type LiteralUnionNumber<T extends number | undefined> = T | (number & NonNullable<unknown>);

package/dist/models/utility.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=utility.types.js.map

package/dist/models/utility.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility.types.js","sourceRoot":"","sources":["../../lib/models/utility.types.ts"],"names":[],"mappings":""}

package/dist/public_api.d.ts

@@ -1,13 +1,21 @@
+/** biome-ignore-all lint/performance/noBarrelFile: One barrel for exported API is fine */
 export { getDefaultHttpAdapter } from "./http/http.adapter.js";
-export type { AdapterRequestOptions, AdapterResponse, DefaultHttpServiceConfig, DownloadFileRequestOptions, ExecuteRequestOptions, HttpAdapter, HttpResponse, HttpService, HttpServiceStatus, UploadFileRequestOptions, } from "./http/http.models.js";
+export type { AdapterBody, AdapterDownloadFileOptions, AdapterExecuteRequestOptions, AdapterPayload, AdapterResponse, DefaultHttpServiceConfig, DownloadFileRequestOptions, ExecuteRequestOptions, GetNextPageData, HttpAdapter, HttpPayload, HttpRequestBody, HttpResponse, HttpResult, HttpService, HttpServiceStatus, PaginationConfig, UploadFileRequestOptions, } from "./http/http.models.js";
 export { getDefaultHttpService } from "./http/http.service.js";
-export type { CommonHeaderNames, Header, HttpMethod, RetryStrategyOptions, SDKInfo, } from "./models/core.models.js";
-export type { CoreSdkError, CoreSdkErrorDetails, ErrorReason, } from "./models/error.models.js";
-export type { JsonArray, JsonObject, JsonValue } from "./models/json.models.js";
-export type { EmptyObject, Override, Prettify } from "./models/utility.models.js";
-export type { CoreResponse, CoreResponseMeta, CoreSdkConfig, PagingQuery, PagingQueryResult, Query, QueryResult, ResultOfSuccessfulQuery, SuccessfulHttpResponse, } from "./sdk/sdk-models.js";
-export { extractContinuationToken, getPagingQuery, getQuery } from "./sdk/sdk-queries.js";
-export { isKontent404Error } from "./utils/error.utils.js";
-export { getSdkIdHeader } from "./utils/header.utils.js";
-export { toRequiredRetryStrategyOptions } from "./utils/retry.utils.js";
-export { tryCatch, tryCatchAsync } from "./utils/try.utils.js";
+export type { CommonHeaderNames, ContinuationHeaderName, ErrorResponseData, Header, HttpMethod, RetryStrategyOptions, SDKInfo, ValidationError, } from "./models/core.models.js";
+export { AdapterAbortError, AdapterParseError, type ErrorDetails, type ErrorDetailsFor, type ErrorReason, KontentSdkError, } from "./models/error.models.js";
+export { type JsonArray, type JsonObject, type JsonValue, jsonValueSchema } from "./models/json.models.js";
+export type { EmptyObject, PickStringLiteral } from "./models/utility.types.js";
+export { createFetchQuery } from "./sdk/queries/fetch-sdk-query.js";
+export { createMutationQuery } from "./sdk/queries/mutation-sdk-query.js";
+export { createPagedFetchQuery } from "./sdk/queries/paged-fetch-sdk-query.js";
+export { kontentUuidSchema, nilUuid } from "./sdk/sdk-config.js";
+export type { FetchQuery, FetchQueryRequest, MutationQuery, MutationQueryRequest, PagedFetchQuery, PagingQueryResult, Query, QueryResponse, QueryResponseMeta, QueryResult, SafePagingQueryResult, SdkConfig, SuccessfulHttpResponse, } from "./sdk/sdk-models.js";
+export { isPagingQuery } from "./sdk/sdk-utils.js";
+export { isDefined } from "./utils/core.utils.js";
+export { isKontent404Error, isKontentSdkError } from "./utils/error.utils.js";
+export { extractContinuationToken, getSdkIdHeader } from "./utils/header.utils.js";
+export { resolveDefaultRetryStrategyOptions } from "./utils/retry.utils.js";
+export { tryCatch, tryCatchAsync } from "./utils/try-catch.utils.js";
+export { getCodenameSchema } from "./utils/type.utils.js";
+export { getEndpointUrl } from "./utils/url.utils.js";

package/dist/public_api.js

@@ -1,9 +1,18 @@
-// biome-ignore lint/performance/noBarrelFile: One barrel for the public API is fine
+/** biome-ignore-all lint/performance/noBarrelFile: One barrel for exported API is fine */
 export { getDefaultHttpAdapter } from "./http/http.adapter.js";
 export { getDefaultHttpService } from "./http/http.service.js";
-export { extractContinuationToken, getPagingQuery, getQuery } from "./sdk/sdk-queries.js";
-export { isKontent404Error } from "./utils/error.utils.js";
-export { getSdkIdHeader } from "./utils/header.utils.js";
-export { toRequiredRetryStrategyOptions } from "./utils/retry.utils.js";
-export { tryCatch, tryCatchAsync } from "./utils/try.utils.js";
+export { AdapterAbortError, AdapterParseError, KontentSdkError, } from "./models/error.models.js";
+export { jsonValueSchema } from "./models/json.models.js";
+export { createFetchQuery } from "./sdk/queries/fetch-sdk-query.js";
+export { createMutationQuery } from "./sdk/queries/mutation-sdk-query.js";
+export { createPagedFetchQuery } from "./sdk/queries/paged-fetch-sdk-query.js";
+export { kontentUuidSchema, nilUuid } from "./sdk/sdk-config.js";
+export { isPagingQuery } from "./sdk/sdk-utils.js";
+export { isDefined } from "./utils/core.utils.js";
+export { isKontent404Error, isKontentSdkError } from "./utils/error.utils.js";
+export { extractContinuationToken, getSdkIdHeader } from "./utils/header.utils.js";
+export { resolveDefaultRetryStrategyOptions } from "./utils/retry.utils.js";
+export { tryCatch, tryCatchAsync } from "./utils/try-catch.utils.js";
+export { getCodenameSchema } from "./utils/type.utils.js";
+export { getEndpointUrl } from "./utils/url.utils.js";
 //# sourceMappingURL=public_api.js.map

package/dist/public_api.js.map

@@ -1 +1 @@
-{"version":3,"file":"public_api.js","sourceRoot":"","sources":["../lib/public_api.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAa/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AA0B/D,OAAO,EAAE,wBAAwB,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"public_api.js","sourceRoot":"","sources":["../lib/public_api.ts"],"names":[],"mappings":"AAAA,0FAA0F;AAC1F,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAqB/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAW/D,OAAO,EACN,iBAAiB,EACjB,iBAAiB,EAIjB,eAAe,GACf,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAmD,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE3G,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,wCAAwC,CAAC;AAC/E,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAgBjE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAE,kCAAkC,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/sdk/queries/fetch-sdk-query.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Shared query models/types intended to be reused across SDKs (e.g. Sync, Delivery, Management)
+ * to keep common code and behavior consistent.
+ */
+import type { JsonValue } from "../../models/json.models.js";
+import type { FetchQuery, FetchQueryRequest } from "../sdk-models.js";
+export declare function createFetchQuery<TResponsePayload extends JsonValue, TMeta, TError>(data: FetchQueryRequest<TResponsePayload, TMeta, TError>): FetchQuery<TResponsePayload, TMeta, TError>;

package/dist/sdk/queries/fetch-sdk-query.js

@@ -0,0 +1,24 @@
+import { resolveQuery } from "../resolve-query.js";
+export function createFetchQuery(data) {
+    const fetchSafe = async () => await resolveQuery({
+        ...data,
+        method: "GET",
+        request: {
+            ...data.request,
+            body: null,
+        },
+    });
+    return {
+        schema: data.zodSchema,
+        url: data.request.url,
+        fetchSafe,
+        fetch: async () => {
+            const { success, response, error } = await fetchSafe();
+            if (!success) {
+                throw error;
+            }
+            return response;
+        },
+    };
+}
+//# sourceMappingURL=fetch-sdk-query.js.map

package/dist/sdk/queries/fetch-sdk-query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-sdk-query.js","sourceRoot":"","sources":["../../../lib/sdk/queries/fetch-sdk-query.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAGnD,MAAM,UAAU,gBAAgB,CAC/B,IAAwD;IAExD,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE,CAC5B,MAAM,YAAY,CAAwC;QACzD,GAAG,IAAI;QACP,MAAM,EAAE,KAAK;QACb,OAAO,EAAE;YACR,GAAG,IAAI,CAAC,OAAO;YACf,IAAI,EAAE,IAAI;SACV;KACD,CAAC,CAAC;IACJ,OAAO;QACN,MAAM,EAAE,IAAI,CAAC,SAAS;QACtB,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;QACrB,SAAS;QACT,KAAK,EAAE,KAAK,IAAI,EAAE;YACjB,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,SAAS,EAAE,CAAC;YACvD,IAAI,CAAC,OAAO,EAAE,CAAC;gBACd,MAAM,KAAK,CAAC;YACb,CAAC;YACD,OAAO,QAAQ,CAAC;QACjB,CAAC;KACD,CAAC;AACH,CAAC"}

package/dist/sdk/queries/mutation-sdk-query.d.ts

@@ -0,0 +1,4 @@
+import type { HttpRequestBody } from "../../http/http.models.js";
+import type { JsonValue } from "../../models/json.models.js";
+import type { MutationQuery, MutationQueryRequest } from "../sdk-models.js";
+export declare function createMutationQuery<TResponsePayload extends JsonValue, TRequestBody extends HttpRequestBody, TMeta, TError>(data: MutationQueryRequest<TResponsePayload, TRequestBody, TMeta, TError>): MutationQuery<TResponsePayload, TMeta, TError>;

package/dist/sdk/queries/mutation-sdk-query.js

@@ -0,0 +1,17 @@
+import { resolveQuery } from "../resolve-query.js";
+export function createMutationQuery(data) {
+    const executeSafe = async () => await resolveQuery(data);
+    return {
+        schema: data.zodSchema,
+        url: data.request.url,
+        executeSafe,
+        execute: async () => {
+            const { success, response, error } = await executeSafe();
+            if (!success) {
+                throw error;
+            }
+            return response;
+        },
+    };
+}
+//# sourceMappingURL=mutation-sdk-query.js.map

package/dist/sdk/queries/mutation-sdk-query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mutation-sdk-query.js","sourceRoot":"","sources":["../../../lib/sdk/queries/mutation-sdk-query.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAGnD,MAAM,UAAU,mBAAmB,CAClC,IAAyE;IAEzE,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE,CAAC,MAAM,YAAY,CAAgD,IAAI,CAAC,CAAC;IAExG,OAAO;QACN,MAAM,EAAE,IAAI,CAAC,SAAS;QACtB,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;QACrB,WAAW;QACX,OAAO,EAAE,KAAK,IAAI,EAAE;YACnB,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,WAAW,EAAE,CAAC;YACzD,IAAI,CAAC,OAAO,EAAE,CAAC;gBACd,MAAM,KAAK,CAAC;YACb,CAAC;YACD,OAAO,QAAQ,CAAC;QACjB,CAAC;KACD,CAAC;AACH,CAAC"}

package/dist/sdk/queries/paged-fetch-sdk-query.d.ts

@@ -0,0 +1,6 @@
+import type { GetNextPageData } from "../../http/http.models.js";
+import type { JsonValue } from "../../models/json.models.js";
+import type { FetchQueryRequest, PagedFetchQuery } from "../sdk-models.js";
+export declare function createPagedFetchQuery<TResponsePayload extends JsonValue, TMeta, TError>(data: FetchQueryRequest<TResponsePayload, TMeta, TError> & {
+    readonly getNextPageData: GetNextPageData<TResponsePayload, TMeta>;
+}): PagedFetchQuery<TResponsePayload, TMeta, TError>;

package/dist/sdk/queries/paged-fetch-sdk-query.js

@@ -0,0 +1,145 @@
+import { match, P } from "ts-pattern";
+import { createSdkError } from "../../utils/error.utils.js";
+import { createFetchQuery } from "./fetch-sdk-query.js";
+export function createPagedFetchQuery(data) {
+    const getPagingData = (config) => {
+        return {
+            ...data,
+            method: "GET",
+            pageIndex: 0,
+            paginationConfig: config ?? {},
+            request: {
+                ...data.request,
+                body: null,
+            },
+        };
+    };
+    const fetchQuery = createFetchQuery(data);
+    return {
+        schema: fetchQuery.schema,
+        url: fetchQuery.url,
+        fetchPage: async () => await fetchQuery.fetch(),
+        fetchPageSafe: async () => await fetchQuery.fetchSafe(),
+        fetchAllPages: async (config) => {
+            const { success, error, lastContinuationToken, partialResponses, responses } = await fetchAllPages(getPagingData(config));
+            if (!success) {
+                throw error;
+            }
+            return {
+                lastContinuationToken,
+                responses,
+                partialResponses,
+            };
+        },
+        fetchAllPagesSafe: async (config) => await fetchAllPages(getPagingData(config)),
+        pagesSafe: (config) => createPagingQueryIterator(getPagingData(config)),
+        pages: async function* (config) {
+            const iterator = createPagingQueryIterator(getPagingData(config));
+            for await (const result of iterator) {
+                if (!result.success) {
+                    throw result.error;
+                }
+                yield result.response;
+            }
+        },
+    };
+}
+async function* createPagingQueryIterator(data) {
+    let nextPageState = { hasNextPage: true, pageSource: "firstRequest" };
+    let pageIndex = 0;
+    while (isNextPageAvailable(nextPageState)) {
+        const urlToUse = nextPageState?.nextPageUrl ?? data.request.url;
+        const { success, response, error } = await createFetchQuery({
+            ...data,
+            request: {
+                ...data.request,
+                url: urlToUse,
+                continuationToken: nextPageState.continuationToken,
+            },
+        }).fetchSafe();
+        if (!success) {
+            yield { success: false, error };
+            return;
+        }
+        yield { success: true, response };
+        pageIndex++;
+        nextPageState = resolveNextPageState({
+            getNextPageData: data.getNextPageData,
+            paginationConfig: data.paginationConfig,
+            pageIndex: pageIndex,
+            response,
+        });
+    }
+}
+function resolveNextPageState({ paginationConfig, getNextPageData, pageIndex, response, }) {
+    return match({ getNextPageData, paginationConfig, pageIndex, response })
+        .returnType()
+        .with({ paginationConfig: { maxPagesCount: 0 } }, () => ({
+        hasNextPage: false,
+    }))
+        .with({ paginationConfig: { maxPagesCount: pageIndex } }, () => ({
+        hasNextPage: false,
+    }))
+        .otherwise((m) => {
+        const responsePageData = m.getNextPageData(m.response);
+        return match(responsePageData)
+            .returnType()
+            .with({ continuationToken: P.string.minLength(1) }, (m) => ({
+            hasNextPage: true,
+            pageSource: "continuationToken",
+            continuationToken: m.continuationToken,
+        }))
+            .with({ nextPageUrl: P.string.minLength(1) }, (m) => ({
+            hasNextPage: true,
+            pageSource: "nextPageUrl",
+            nextPageUrl: m.nextPageUrl,
+        }))
+            .otherwise(() => ({
+            hasNextPage: false,
+        }));
+    });
+}
+async function fetchAllPages(data) {
+    const responses = [];
+    for await (const result of createPagingQueryIterator(data)) {
+        if (!result.success) {
+            return { success: false, error: result.error, partialResponses: responses };
+        }
+        responses.push(result.response);
+    }
+    return validateAndBuildPagingResult({
+        responses,
+        initialUrl: data.request.url,
+        mapError: data.mapError,
+    });
+}
+function validateAndBuildPagingResult({ responses, initialUrl, mapError, }) {
+    const lastResponse = responses.at(-1);
+    if (!lastResponse) {
+        return {
+            success: false,
+            partialResponses: responses,
+            error: mapError(createSdkError({
+                baseErrorData: {
+                    retryStrategyOptions: undefined,
+                    retryAttempt: undefined,
+                    url: initialUrl,
+                    message: "No responses were processed. Expected at least one response to be fetched when using paging queries.",
+                },
+                details: {
+                    reason: "noResponses",
+                    url: initialUrl,
+                },
+            })),
+        };
+    }
+    return {
+        success: true,
+        responses: responses,
+        lastContinuationToken: lastResponse.meta.continuationToken,
+    };
+}
+function isNextPageAvailable(nextPageState) {
+    return nextPageState.hasNextPage;
+}
+//# sourceMappingURL=paged-fetch-sdk-query.js.map

package/dist/sdk/queries/paged-fetch-sdk-query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paged-fetch-sdk-query.js","sourceRoot":"","sources":["../../../lib/sdk/queries/paged-fetch-sdk-query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,YAAY,CAAC;AAItC,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAS5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAYxD,MAAM,UAAU,qBAAqB,CACpC,IAEC;IAED,MAAM,aAAa,GAAmH,CACrI,MAAM,EACL,EAAE;QACH,OAAO;YACN,GAAG,IAAI;YACP,MAAM,EAAE,KAAK;YACb,SAAS,EAAE,CAAC;YACZ,gBAAgB,EAAE,MAAM,IAAI,EAAE;YAC9B,OAAO,EAAE;gBACR,GAAG,IAAI,CAAC,OAAO;gBACf,IAAI,EAAE,IAAI;aACV;SACD,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,gBAAgB,CAAkC,IAAI,CAAC,CAAC;IAE3E,OAAO;QACN,MAAM,EAAE,UAAU,CAAC,MAAM;QACzB,GAAG,EAAE,UAAU,CAAC,GAAG;QACnB,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,UAAU,CAAC,KAAK,EAAE;QAC/C,aAAa,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,UAAU,CAAC,SAAS,EAAE;QACvD,aAAa,EAAE,KAAK,EAAE,MAAyB,EAAE,EAAE;YAClD,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,SAAS,EAAE,GAAG,MAAM,aAAa,CAIhG,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACd,MAAM,KAAK,CAAC;YACb,CAAC;YACD,OAAO;gBACN,qBAAqB;gBACrB,SAAS;gBACT,gBAAgB;aAChB,CAAC;QACH,CAAC;QACD,iBAAiB,EAAE,KAAK,EAAE,MAAyB,EAAE,EAAE,CAAC,MAAM,aAAa,CAAkC,aAAa,CAAC,MAAM,CAAC,CAAC;QACnI,SAAS,EAAE,CAAC,MAAyB,EAAE,EAAE,CAAC,yBAAyB,CAAkC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3H,KAAK,EAAE,KAAK,SAAS,CAAC,EAAE,MAAyB;YAChD,MAAM,QAAQ,GAAG,yBAAyB,CAAkC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;YACnG,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;gBACrC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACrB,MAAM,MAAM,CAAC,KAAK,CAAC;gBACpB,CAAC;gBACD,MAAM,MAAM,CAAC,QAAQ,CAAC;YACvB,CAAC;QACF,CAAC;KACD,CAAC;AACH,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,yBAAyB,CACxC,IAA6F;IAE7F,IAAI,aAAa,GAAkB,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC;IACrF,IAAI,SAAS,GAAW,CAAC,CAAC;IAE1B,OAAO,mBAAmB,CAAC,aAAa,CAAC,EAAE,CAAC;QAC3C,MAAM,QAAQ,GAAW,aAAa,EAAE,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;QAExE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,gBAAgB,CAAkC;YAC5F,GAAG,IAAI;YACP,OAAO,EAAE;gBACR,GAAG,IAAI,CAAC,OAAO;gBACf,GAAG,EAAE,QAAQ;gBACb,iBAAiB,EAAE,aAAa,CAAC,iBAAiB;aAClD;SACD,CAAC,CAAC,SAAS,EAAE,CAAC;QAEf,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;YAChC,OAAO;QACR,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAElC,SAAS,EAAE,CAAC;QACZ,aAAa,GAAG,oBAAoB,CAAC;YACpC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,SAAS,EAAE,SAAS;YACpB,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;AACF,CAAC;AAED,SAAS,oBAAoB,CAA4C,EACxE,gBAAgB,EAChB,eAAe,EACf,SAAS,EACT,QAAQ,GAMR;IACA,OAAO,KAAK,CAAC,EAAE,eAAe,EAAE,gBAAgB,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;SACtE,UAAU,EAAiB;SAC3B,IAAI,CAAC,EAAE,gBAAgB,EAAE,EAAE,aAAa,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QACxD,WAAW,EAAE,KAAK;KAClB,CAAC,CAAC;SACF,IAAI,CAAC,EAAE,gBAAgB,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QAChE,WAAW,EAAE,KAAK;KAClB,CAAC,CAAC;SACF,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;QAChB,MAAM,gBAAgB,GAAG,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAEvD,OAAO,KAAK,CAAC,gBAAgB,CAAC;aAC5B,UAAU,EAAiB;aAC3B,IAAI,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAC3D,WAAW,EAAE,IAAI;YACjB,UAAU,EAAE,mBAAmB;YAC/B,iBAAiB,EAAE,CAAC,CAAC,iBAAiB;SACtC,CAAC,CAAC;aACF,IAAI,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACrD,WAAW,EAAE,IAAI;YACjB,UAAU,EAAE,aAAa;YACzB,WAAW,EAAE,CAAC,CAAC,WAAW;SAC1B,CAAC,CAAC;aACF,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC;YACjB,WAAW,EAAE,KAAK;SAClB,CAAC,CAAC,CAAC;IACN,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,aAAa,CAC3B,IAIC;IAED,MAAM,SAAS,GAA6C,EAAE,CAAC;IAE/D,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,yBAAyB,CAAkC,IAAI,CAAC,EAAE,CAAC;QAC7F,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACrB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,CAAC;QAC7E,CAAC;QAED,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,4BAA4B,CAAkC;QACpE,SAAS;QACT,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;QAC5B,QAAQ,EAAE,IAAI,CAAC,QAAQ;KACvB,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,CAAoD,EACxF,SAAS,EACT,UAAU,EACV,QAAQ,GAKR;IACA,MAAM,YAAY,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEtC,IAAI,CAAC,YAAY,EAAE,CAAC;QACnB,OAAO;YACN,OAAO,EAAE,KAAK;YACd,gBAAgB,EAAE,SAAS;YAC3B,KAAK,EAAE,QAAQ,CACd,cAAc,CAAC;gBACd,aAAa,EAAE;oBACd,oBAAoB,EAAE,SAAS;oBAC/B,YAAY,EAAE,SAAS;oBACvB,GAAG,EAAE,UAAU;oBACf,OAAO,EAAE,sGAAsG;iBAC/G;gBACD,OAAO,EAAE;oBACR,MAAM,EAAE,aAAa;oBACrB,GAAG,EAAE,UAAU;iBACf;aACD,CAAC,CACF;SACD,CAAC;IACH,CAAC;IAED,OAAO;QACN,OAAO,EAAE,IAAI;QACb,SAAS,EAAE,SAAS;QACpB,qBAAqB,EAAE,YAAY,CAAC,IAAI,CAAC,iBAAiB;KAC1D,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,aAA4B;IACxD,OAAO,aAAa,CAAC,WAAW,CAAC;AAClC,CAAC"}

package/dist/sdk/resolve-query.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Shared query models/types intended to be reused across SDKs (e.g. Sync, Delivery, Management)
+ * to keep common code and behavior consistent.
+ */
+import type { HttpRequestBody } from "../http/http.models.js";
+import type { JsonValue } from "../models/json.models.js";
+import type { QueryPromiseResult, ResolveQueryData } from "./sdk-models.js";
+export declare function resolveQuery<TResponsePayload extends JsonValue, TRequestBody extends HttpRequestBody, TMeta, TError>({ config, request, mapMetadata, zodSchema, sdkInfo, method, abortSignal, mapError, }: ResolveQueryData<TResponsePayload, TRequestBody, TMeta, TError>): QueryPromiseResult<TResponsePayload, TMeta, TError>;