@kestra-io/kestra-sdk 2.0.0 → 2.0.2

package/dist/index-Df3oXFWk.d.ts

@@ -0,0 +1,101 @@
+import { Mnt as Client, Nnt as ClientOptions, Pnt as Config } from "./types.gen-DVT5DQ0q.js";
+
+//#region ../node_modules/@kestra-io/hey-api-plugin/dist/runtime.d.ts
+//#region src/errors.d.ts
+/**
+ * Thrown by `createConfigureClient`'s error interceptor instead of a generic normalized `Error`
+ * when a request 404s against a route that only exists in Kestra Enterprise Edition — e.g. an
+ * EE-only SDK method (`listAuditLogs`, `listApps`, ...) called against an OSS server.
+ *
+ * Carries structured fields (not just a message) so a caller can render its own "Upgrade to
+ * unlock X" UI — a CLI, an internal dashboard, a bot — without parsing `error.message`.
+ */
+declare class EnterpriseFeatureError extends Error {
+  /** HTTP status of the underlying response. Always 404: the route genuinely doesn't exist on an OSS server. */
+  readonly status: number;
+  /** Feature identifier supplied by the matching `EnterpriseFeatureConfig`, e.g. "audit-logs". */
+  readonly feature: string;
+  /** Kestra Enterprise Edition docs page for this feature. */
+  readonly docsUrl: string;
+  /** Contact-sales / start-a-trial link for this feature. */
+  readonly contactSalesUrl: string;
+  constructor(options: {
+    feature: string;
+    docsUrl: string;
+    contactSalesUrl: string;
+    status?: number;
+  });
+}
+/**
+ * Thrown instead of {@link EnterpriseFeatureError} when a matched EE-only route 404s on a server
+ * that confirms it's EE — an SDK/server version mismatch, not a licensing issue.
+ */
+declare class SdkVersionMismatchError extends Error {
+  /** HTTP status of the underlying response. Always 404. */
+  readonly status: number;
+  /** Feature identifier supplied by the matching `EnterpriseFeatureConfig`, e.g. "audit-logs". */
+  readonly feature: string;
+  constructor(options: {
+    feature: string;
+    status?: number;
+  });
+}
+/** A route matched as Enterprise-Edition-only. */
+//#endregion
+//#region src/index.d.ts
+declare global {
+  interface Window {
+    KESTRA_BASE_PATH: string;
+  }
+}
+interface AxiosLikeConfig {
+  params?: Record<string, unknown>;
+  headers?: Record<string, string>;
+  responseType?: "json" | "text" | "blob";
+  timeout?: number;
+  validateStatus?: (status: number) => boolean;
+  [key: string]: any;
+}
+interface AxiosLikeResponse<T = any> {
+  data: T;
+  status: number;
+  headers: Record<string, string>;
+  request?: {
+    responseURL: string;
+  };
+}
+declare const axiosLikeClient: {
+  readonly defaults: {
+    readonly headers: {
+      readonly common: Record<string, string>;
+    };
+  };
+  readonly get: <T = any>(url: string, config?: AxiosLikeConfig) => Promise<AxiosLikeResponse<T>>;
+  readonly post: <T = any>(url: string, data?: any, config?: AxiosLikeConfig) => Promise<AxiosLikeResponse<T>>;
+  readonly put: <T = any>(url: string, data?: any, config?: AxiosLikeConfig) => Promise<AxiosLikeResponse<T>>;
+  readonly delete: <T = any>(url: string, config?: AxiosLikeConfig) => Promise<AxiosLikeResponse<T>>;
+  readonly patch: <T = any>(url: string, data?: any, config?: AxiosLikeConfig) => Promise<AxiosLikeResponse<T>>;
+};
+declare const featureToSlugMap: Record<string, string>;
+declare const configureClient: (clientConfig?: Config<ClientOptions> | undefined) => Client;
+/**
+ * Set a mock client instance controlled in tests
+ */
+declare function setMockClient(mockClient?: Partial<typeof axiosLikeClient>): void;
+/**
+ * Get the current fetch client instance
+ */
+declare function useClient(): {
+  readonly defaults: {
+    readonly headers: {
+      readonly common: Record<string, string>;
+    };
+  };
+  readonly get: <T = any>(url: string, config?: AxiosLikeConfig) => Promise<AxiosLikeResponse<T>>;
+  readonly post: <T = any>(url: string, data?: any, config?: AxiosLikeConfig) => Promise<AxiosLikeResponse<T>>;
+  readonly put: <T = any>(url: string, data?: any, config?: AxiosLikeConfig) => Promise<AxiosLikeResponse<T>>;
+  readonly delete: <T = any>(url: string, config?: AxiosLikeConfig) => Promise<AxiosLikeResponse<T>>;
+  readonly patch: <T = any>(url: string, data?: any, config?: AxiosLikeConfig) => Promise<AxiosLikeResponse<T>>;
+};
+//#endregion
+export { setMockClient as a, SdkVersionMismatchError as c, featureToSlugMap as i, AxiosLikeResponse as n, useClient as o, configureClient as r, EnterpriseFeatureError as s, AxiosLikeConfig as t };