@giveitsmaller/sdk 0.8.0 → 0.10.0

package/dist/ergonomic/presets/index.js

@@ -41,7 +41,7 @@ export { DocumentOfficeCompressPresetOptions, } from './document_office_compress
 export { DocumentOdfCompressPresetOptions, } from './document_odf_compress.js';
 export { DocumentEpubCompressPresetOptions, } from './document_epub_compress.js';
 // Re-export ergonomic enums for callers (single canonical path).
-export { OptimizeFor, ImageMode, ImageFit, ImageMetadataPolicy, IccProfilePolicy, ImageFormat, VideoCodec, VideoPreset, VideoFit, AudioBitrate, AudioCodec, AudioSampleRate, PdfProfile, PdfColorspace, } from '../../generated/sdk_spec/enums.js';
+export { OptimizeFor, ImageMode, ImageMetadataPolicy, IccProfilePolicy, ImageFormat, VideoCodec, VideoPreset, VideoFit, AudioBitrate, AudioCodec, AudioSampleRate, PdfProfile, PdfColorspace, } from '../../generated/sdk_spec/enums.js';
 function cellKeyOf(media, op) {
     return `${media}_${op}`;
 }

package/dist/errors.d.ts

@@ -1,4 +1,4 @@
-import type { AuthErrorResponse, BalanceExhaustedResponse, FeatureNotAvailableResponse, FeatureTierRestrictedResponse, ProbePendingResponse, TierRestrictionResponse, UploadDurationExceedsTierResponse, UploadSizeExceedsTierResponse, WorkflowExpiredResponse } from '@giveitsmaller/contracts/openapi';
+import type { AuthErrorResponse, AuthRejectionEnvelope, AuthRejectionEnvelopeErrorTypeEnum, BalanceExhaustedResponse, FeatureNotAvailableResponse, FeatureTierRestrictedResponse, ProbePendingResponse, TierRestrictionResponse, UploadDurationExceedsTierResponse, UploadSizeExceedsTierResponse, WorkflowExpiredResponse } from '@giveitsmaller/contracts/openapi';
 export declare class GislError extends Error {
     constructor(message: string);
 }
@@ -14,6 +14,21 @@ export interface GislApiErrorOptions {
     readonly locale?: string;
     readonly messageParams?: Record<string, unknown>;
     readonly payload?: unknown;
+    /**
+     * The response headers from the HTTP response that produced this error.
+     * Keys are LOWERCASED (HTTP header names are case-insensitive per RFC 9110,
+     * and `Headers.forEach` yields lowercased keys). Multi-value headers (e.g.
+     * `set-cookie`) are collapsed to a single comma-joined string — do NOT rely
+     * on this map for cookies.
+     */
+    readonly responseHeaders?: Record<string, string>;
+    /**
+     * The resolved language the server reported via the `Content-Language`
+     * response header. DISTINCT from `locale`, which is the body-envelope
+     * localisation tag (the I26 `ErrorEnvelope.locale` field); `contentLanguage`
+     * is the transport-level header the server echoes for content negotiation.
+     */
+    readonly contentLanguage?: string;
 }
 export declare class GislApiError extends GislError {
     readonly statusCode: number;
@@ -24,6 +39,19 @@ export declare class GislApiError extends GislError {
     readonly locale?: string;
     readonly messageParams?: Record<string, unknown>;
     readonly payload?: unknown;
+    /**
+     * Response headers from the HTTP response that produced this error, with
+     * LOWERCASED keys (RFC 9110 case-insensitive). Multi-value headers such as
+     * `set-cookie` are collapsed into a single comma-joined string — don't rely
+     * on this map for cookies.
+     */
+    readonly responseHeaders?: Record<string, string>;
+    /**
+     * The `Content-Language` response header value (the language the server
+     * actually resolved). DISTINCT from `locale`, which is the body-envelope
+     * localisation tag.
+     */
+    readonly contentLanguage?: string;
     constructor(statusCode: number, errorMessage: string, path?: string, details?: unknown, options?: GislApiErrorOptions);
 }
 /**
@@ -101,6 +129,23 @@ export declare class GislAuthError extends GislApiError {
     readonly payload: AuthErrorResponse;
     constructor(statusCode: number, errorMessage: string, payload: AuthErrorResponse, path?: string, extra?: Omit<GislApiErrorOptions, 'payload'>);
 }
+/**
+ * 422 Unprocessable Entity — domain rejection on auth side-effect endpoints
+ * (register / verify-email / api-keys duplicate-or-invalid; profile PATCH email
+ * unchanged). Flat `AuthRejectionEnvelope`, no `details[]`. Mirrors the PHP
+ * `Gisl\Sdk\Errors\GislAuthRejectionError`.
+ *
+ * `payload.errorType` is the auth-422 `oneOf` discriminator
+ * (`unprocessable_entity` or `email_same`); `errorType` re-exposes it directly
+ * for caller-side narrowing without unwrapping the typed payload. Distinct from
+ * `GislValidationError` (the `validation_error` branch of the same `oneOf`,
+ * which carries `details[]`).
+ */
+export declare class GislAuthRejectionError extends GislApiError {
+    readonly payload: AuthRejectionEnvelope;
+    readonly errorType: AuthRejectionEnvelopeErrorTypeEnum;
+    constructor(statusCode: number, errorMessage: string, payload: AuthRejectionEnvelope, path?: string, extra?: Omit<GislApiErrorOptions, 'payload'>);
+}
 /**
  * Discriminates the four upload-too-big shapes the server can return:
  * - `size_tier`        — 422 `upload_size_exceeds_tier` (typed payload present)
@@ -312,6 +357,19 @@ export declare class GislTimeoutError extends GislError {
 export declare class GislNetworkError extends GislError {
     constructor(message: string);
 }
+/**
+ * Internal control-flow marker (TDqmkWpX): the SSE event stream closed cleanly
+ * WITHOUT a terminal (`workflow_completed`/`failed`/`partially_failed`) event.
+ * Raised by {@link _consumeSseToTerminal} so the await-terminal callers can
+ * distinguish a benign server-side stream close (→ fall back to polling) from a
+ * genuine failure that must propagate (an `onProgress` callback throw, an API
+ * error, a caller abort). Mirrors the PHP `SseStreamEndedWithoutTerminal`
+ * sealed marker. Not part of the public error contract — never surfaced to a
+ * caller (the await-terminal path catches it internally and polls).
+ */
+export declare class SseEndedWithoutTerminal extends GislError {
+    constructor(message?: string);
+}
 export declare class GislAbortError extends GislError {
     constructor(message: string);
 }
@@ -348,6 +406,22 @@ export declare class GislMultipartPartCountError extends GislError {
 export declare class GislNoSuchKeyError extends GislError {
     constructor(message: string);
 }
+/**
+ * Thrown by the file-first `Handle.result()` (FF5a) when the workflow has not
+ * yet reached a terminal state. `result()` is the NON-blocking accessor: it
+ * fetches the current status once and, if the workflow is still
+ * `pending`/`in_progress`, throws this rather than waiting. Use `Handle.wait()`
+ * to block until terminal instead.
+ *
+ * Carries the `workflowId` and the current (non-terminal) `state`.
+ *
+ * Mirrors the PHP `Gisl\Sdk\Errors\GislResultNotReadyError`.
+ */
+export declare class GislResultNotReadyError extends GislError {
+    readonly workflowId: string;
+    readonly state: string;
+    constructor(workflowId: string, state: string);
+}
 /** Machine-readable cause carried by {@link GislSinkError}. */
 export type GislSinkErrorReason = 'not_single_output' | 'downloader_unavailable' | 'partial_failure' | 'duplicate_filename' | 'invalid_directory' | 'write_failed';
 /**

package/dist/errors.js

@@ -13,6 +13,19 @@ export class GislApiError extends GislError {
     locale;
     messageParams;
     payload;
+    /**
+     * Response headers from the HTTP response that produced this error, with
+     * LOWERCASED keys (RFC 9110 case-insensitive). Multi-value headers such as
+     * `set-cookie` are collapsed into a single comma-joined string — don't rely
+     * on this map for cookies.
+     */
+    responseHeaders;
+    /**
+     * The `Content-Language` response header value (the language the server
+     * actually resolved). DISTINCT from `locale`, which is the body-envelope
+     * localisation tag.
+     */
+    contentLanguage;
     constructor(statusCode, errorMessage, path, details, options) {
         const prefix = path
             ? `API error ${statusCode} at ${path}`
@@ -28,6 +41,8 @@ export class GislApiError extends GislError {
             this.locale = options.locale;
             this.messageParams = options.messageParams;
             this.payload = options.payload;
+            this.responseHeaders = options.responseHeaders;
+            this.contentLanguage = options.contentLanguage;
         }
     }
 }
@@ -112,6 +127,26 @@ export class GislAuthError extends GislApiError {
         this.name = 'GislAuthError';
     }
 }
+/**
+ * 422 Unprocessable Entity — domain rejection on auth side-effect endpoints
+ * (register / verify-email / api-keys duplicate-or-invalid; profile PATCH email
+ * unchanged). Flat `AuthRejectionEnvelope`, no `details[]`. Mirrors the PHP
+ * `Gisl\Sdk\Errors\GislAuthRejectionError`.
+ *
+ * `payload.errorType` is the auth-422 `oneOf` discriminator
+ * (`unprocessable_entity` or `email_same`); `errorType` re-exposes it directly
+ * for caller-side narrowing without unwrapping the typed payload. Distinct from
+ * `GislValidationError` (the `validation_error` branch of the same `oneOf`,
+ * which carries `details[]`).
+ */
+export class GislAuthRejectionError extends GislApiError {
+    errorType;
+    constructor(statusCode, errorMessage, payload, path, extra) {
+        super(statusCode, errorMessage, path, undefined, buildOptionsWithPayload(payload, extra));
+        this.name = 'GislAuthRejectionError';
+        this.errorType = payload.errorType;
+    }
+}
 /**
  * A single class covering all three "upload exceeds a size/duration cap"
  * responses (422 size-tier, 422 duration-tier, 413 absolute).
@@ -335,6 +370,22 @@ export class GislNetworkError extends GislError {
         this.name = 'GislNetworkError';
     }
 }
+/**
+ * Internal control-flow marker (TDqmkWpX): the SSE event stream closed cleanly
+ * WITHOUT a terminal (`workflow_completed`/`failed`/`partially_failed`) event.
+ * Raised by {@link _consumeSseToTerminal} so the await-terminal callers can
+ * distinguish a benign server-side stream close (→ fall back to polling) from a
+ * genuine failure that must propagate (an `onProgress` callback throw, an API
+ * error, a caller abort). Mirrors the PHP `SseStreamEndedWithoutTerminal`
+ * sealed marker. Not part of the public error contract — never surfaced to a
+ * caller (the await-terminal path catches it internally and polls).
+ */
+export class SseEndedWithoutTerminal extends GislError {
+    constructor(message = 'SSE stream ended without a terminal event') {
+        super(message);
+        this.name = 'SseEndedWithoutTerminal';
+    }
+}
 export class GislAbortError extends GislError {
     constructor(message) {
         super(message);
@@ -387,6 +438,28 @@ export class GislNoSuchKeyError extends GislError {
         this.name = 'GislNoSuchKeyError';
     }
 }
+/**
+ * Thrown by the file-first `Handle.result()` (FF5a) when the workflow has not
+ * yet reached a terminal state. `result()` is the NON-blocking accessor: it
+ * fetches the current status once and, if the workflow is still
+ * `pending`/`in_progress`, throws this rather than waiting. Use `Handle.wait()`
+ * to block until terminal instead.
+ *
+ * Carries the `workflowId` and the current (non-terminal) `state`.
+ *
+ * Mirrors the PHP `Gisl\Sdk\Errors\GislResultNotReadyError`.
+ */
+export class GislResultNotReadyError extends GislError {
+    workflowId;
+    state;
+    constructor(workflowId, state) {
+        super(`Workflow ${workflowId} is not ready (state '${state}'); its result is not available yet. ` +
+            'Call wait() to block until it reaches a terminal state, or poll result() again later.');
+        this.name = 'GislResultNotReadyError';
+        this.workflowId = workflowId;
+        this.state = state;
+    }
+}
 /**
  * Thrown by the file-first `RunResult` sinks (`toFile()` / `downloadTo()`,
  * FF1) when they cannot deliver. The machine-readable `reason` discriminates