@oomol-lab/open-flow 0.1.0-beta.74 → 0.1.0-beta.75

package/dist/common/http-request.d.ts

@@ -0,0 +1,156 @@
+import type { InputMapping, JsonValue, ManagedTaskDefinition, TaskNode } from './flow-change.js';
+import { z } from 'zod';
+export declare const httpRequestConfigSchema: z.ZodObject<{
+    method: z.ZodDefault<z.ZodEnum<{
+        DELETE: "DELETE";
+        GET: "GET";
+        HEAD: "HEAD";
+        OPTIONS: "OPTIONS";
+        PATCH: "PATCH";
+        POST: "POST";
+        PUT: "PUT";
+    }>>;
+    query: z.ZodDefault<z.ZodObject<{
+        mode: z.ZodDefault<z.ZodEnum<{
+            fields: "fields";
+            object: "object";
+        }>>;
+        names: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+    headers: z.ZodDefault<z.ZodObject<{
+        mode: z.ZodDefault<z.ZodEnum<{
+            fields: "fields";
+            object: "object";
+        }>>;
+        names: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+    bodyFormat: z.ZodDefault<z.ZodEnum<{
+        form: "form";
+        json: "json";
+        none: "none";
+        text: "text";
+    }>>;
+    authentication: z.ZodDefault<z.ZodUnion<readonly [z.ZodObject<{
+        type: z.ZodLiteral<"none">;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodEnum<{
+            basic: "basic";
+            bearer: "bearer";
+        }>;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"apiKey">;
+        name: z.ZodString;
+        in: z.ZodEnum<{
+            header: "header";
+            query: "query";
+        }>;
+    }, z.core.$strict>]>>;
+    responseFormat: z.ZodDefault<z.ZodEnum<{
+        auto: "auto";
+        json: "json";
+        text: "text";
+    }>>;
+    statusPolicy: z.ZodDefault<z.ZodEnum<{
+        all: "all";
+        success: "success";
+    }>>;
+}, z.core.$strict>;
+export type HttpRequestConfig = z.infer<typeof httpRequestConfigSchema>;
+export interface HttpRequestExecutor extends HttpRequestConfig {
+    readonly kind: 'http-request';
+}
+export declare const httpRequestExecutorSchema: z.ZodObject<{
+    method: z.ZodDefault<z.ZodEnum<{
+        DELETE: "DELETE";
+        GET: "GET";
+        HEAD: "HEAD";
+        OPTIONS: "OPTIONS";
+        PATCH: "PATCH";
+        POST: "POST";
+        PUT: "PUT";
+    }>>;
+    query: z.ZodDefault<z.ZodObject<{
+        mode: z.ZodDefault<z.ZodEnum<{
+            fields: "fields";
+            object: "object";
+        }>>;
+        names: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+    headers: z.ZodDefault<z.ZodObject<{
+        mode: z.ZodDefault<z.ZodEnum<{
+            fields: "fields";
+            object: "object";
+        }>>;
+        names: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>>;
+    bodyFormat: z.ZodDefault<z.ZodEnum<{
+        form: "form";
+        json: "json";
+        none: "none";
+        text: "text";
+    }>>;
+    authentication: z.ZodDefault<z.ZodUnion<readonly [z.ZodObject<{
+        type: z.ZodLiteral<"none">;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodEnum<{
+            basic: "basic";
+            bearer: "bearer";
+        }>;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"apiKey">;
+        name: z.ZodString;
+        in: z.ZodEnum<{
+            header: "header";
+            query: "query";
+        }>;
+    }, z.core.$strict>]>>;
+    responseFormat: z.ZodDefault<z.ZodEnum<{
+        auto: "auto";
+        json: "json";
+        text: "text";
+    }>>;
+    statusPolicy: z.ZodDefault<z.ZodEnum<{
+        all: "all";
+        success: "success";
+    }>>;
+    kind: z.ZodLiteral<"http-request">;
+}, z.core.$strict>;
+export declare const httpHeaderSchema: {
+    type: string;
+    additionalProperties: {
+        type: string;
+    };
+};
+export declare const httpQuerySchema: {
+    type: string;
+    additionalProperties: {
+        anyOf: ({
+            type: string[];
+        } | {
+            type: string;
+            items: {
+                type: string[];
+            };
+        })[];
+    };
+};
+export declare function httpAuthHandles(config: HttpRequestConfig): string[];
+export declare function httpRequestTask(config?: HttpRequestConfig, name?: string, previous?: ManagedTaskDefinition): ManagedTaskDefinition;
+export interface HttpRequestIssue {
+    field: string;
+    index?: number;
+    code: 'bodyUnsupported' | 'parameterNamesInvalid' | 'headerNameInvalid' | 'keyNameRequired' | 'authConflict';
+    message: string;
+}
+export declare function httpRequestIssues(config: HttpRequestConfig): HttpRequestIssue[];
+export declare function httpRequestUrl(value: unknown): URL;
+export declare function buildHttpRequest(config: HttpRequestConfig, input: Readonly<Record<string, JsonValue>>): {
+    url: string;
+    init: RequestInit;
+};
+export declare function parseHttpResponse(config: HttpRequestConfig, status: number, headers: Headers, text: string): Record<string, JsonValue>;
+/** Only a named parameter rename carries a value; changing source modes is not a rename. */
+export declare function httpRequestInputs(mappings: Readonly<Record<string, InputMapping>>, previous: ManagedTaskDefinition, next: ManagedTaskDefinition): Record<string, InputMapping>;
+/** The object editor assembles named inputs without changing unrelated request settings. */
+export declare function withHttpParameterFields(node: TaskNode, group: 'query' | 'headers', values: Record<string, JsonValue>): TaskNode;
+export declare function withHttpParameterSource(node: TaskNode, group: 'query' | 'headers', mapping?: InputMapping): TaskNode;