@appaloft/sdk 0.12.0

package/dist/index.d.ts

@@ -0,0 +1,79 @@
+export declare const apiVersion = "v1";
+export { generatedSdkOperations } from "./generated-operations";
+export type DomainErrorDetailValue = string | number | boolean | null | readonly string[];
+export interface DomainErrorResponse {
+    readonly code: string;
+    readonly category: "user" | "infra" | "provider" | "retryable" | "timeout";
+    readonly message: string;
+    readonly retryable: boolean;
+    readonly details?: Readonly<Record<string, DomainErrorDetailValue>>;
+}
+export type SdkOperationKind = "command" | "query";
+export type SdkAuthPolicy = "bootstrap-public" | "product-session" | "webhook-signature";
+export interface SdkOperationRoute {
+    readonly method: string;
+    readonly path: string;
+}
+export interface SdkOperationDescriptor {
+    readonly operationKey: string;
+    readonly operationGroup: string;
+    readonly operationMethod: string;
+    readonly operationId: string;
+    readonly kind: SdkOperationKind;
+    readonly domain: string;
+    readonly messageName: string;
+    readonly route: SdkOperationRoute;
+    readonly docsHref?: string;
+    readonly authPolicy: SdkAuthPolicy;
+    readonly errorFamily: string;
+    readonly streaming: boolean;
+}
+export type AppaloftSdkAuth = {
+    readonly kind: "none";
+} | {
+    readonly kind: "product-session";
+    readonly cookie: string;
+} | {
+    readonly kind: "deploy-token";
+    readonly token: string;
+};
+export type AppaloftSdkFetch = (request: Request) => Promise<Response>;
+export interface AppaloftSdkClientOptions {
+    readonly baseUrl: string;
+    readonly auth?: AppaloftSdkAuth | (() => AppaloftSdkAuth | undefined);
+    readonly fetch?: AppaloftSdkFetch;
+    readonly headers?: HeadersInit | (() => HeadersInit);
+}
+export interface AppaloftSdkOperationRequest {
+    readonly operation: SdkOperationDescriptor;
+    readonly pathParams?: Readonly<Record<string, string>>;
+    readonly query?: Readonly<Record<string, string | number | boolean | null | undefined>>;
+    readonly body?: unknown;
+    readonly signal?: AbortSignal;
+}
+export interface AppaloftSdkStreamRequest<TEnvelope = unknown> extends AppaloftSdkOperationRequest {
+    readonly parseEnvelope?: (value: unknown) => TEnvelope;
+}
+export type AppaloftSdkOperationResult<T> = {
+    readonly ok: true;
+    readonly status: number;
+    readonly data: T;
+} | {
+    readonly ok: false;
+    readonly status: number;
+    readonly error: DomainErrorResponse;
+};
+export interface AppaloftSdkClient {
+    readonly apiVersion: typeof apiVersion;
+    readonly request: <T = unknown>(input: AppaloftSdkOperationRequest) => Promise<AppaloftSdkOperationResult<T>>;
+    readonly stream: <TEnvelope = unknown>(input: AppaloftSdkStreamRequest<TEnvelope>) => AsyncIterable<TEnvelope>;
+}
+export declare class AppaloftSdkStreamError extends Error {
+    readonly status: number;
+    readonly error: DomainErrorResponse;
+    constructor(message: string, status: number, error: DomainErrorResponse);
+}
+export declare function createAppaloftSdkClient(options: AppaloftSdkClientOptions): AppaloftSdkClient;
+export declare function isAppaloftSdkErrorCode<TCode extends string>(error: DomainErrorResponse, code: TCode): error is DomainErrorResponse & {
+    readonly code: TCode;
+};