@oomol-lab/open-connector 1.9.0 → 1.9.2

package/src/providers/smooth/actions.js

@@ -0,0 +1,138 @@
+import { jsonSchema as s } from "../../core/json-schema.js";
+import { defineProviderAction } from "../../core/provider-definition.js";
+const taskId = s.nonEmptyString("Task ID returned by submit_task.");
+const profileId = s.nonEmptyString("Browser profile ID.");
+const taskOutput = {
+    ...s.looseObject("Task status, result and upstream metadata.", {
+        id: taskId,
+        status: s.string("Task state: waiting, running, done, failed or cancelled."),
+        output: s.unknown("Task output, optionally matching response_model."),
+        credits_used: s.nullable(s.integer("Credits used by the task.")),
+        device: s.nullable(s.string("Browser device type.")),
+        live_url: s.nullable(s.string("URL for live browser access.")),
+        recording_url: s.nullable(s.string("URL for the task recording.")),
+        downloads_url: s.nullable(s.string("URL for downloaded files.")),
+        created_at: s.nullable(s.integer("Task creation Unix timestamp.")),
+        events: s.nullable(s.array("New task events.", s.looseObject("Upstream event payload."))),
+    }),
+    required: ["id", "status"],
+};
+const profileOutput = s.looseRequiredObject("Browser profile.", { id: profileId });
+const success = s.requiredObject("Operation result.", {
+    success: s.boolean("Whether the operation succeeded."),
+});
+const taskOptions = {
+    response_model: s.nullable(s.looseObject("JSON Schema for the desired task output.")),
+    url: s.nullable(s.string("Starting URL visited by Smooth.", { format: "uri" })),
+    metadata: s.nullable({
+        ...s.record("Agent variables; at most 16 keys and 2048 characters per string value.", s.anyOf("Variable value.", [
+            s.string("Text value.", { maxLength: 2048 }),
+            s.number("Numeric value."),
+            s.boolean("Boolean value."),
+        ])),
+        maxProperties: 16,
+    }),
+    files: s.nullable(s.array("Previously uploaded file IDs.", s.string("File ID."))),
+    agent: s.stringEnum("Agent model; defaults to smooth.", ["smooth", "smooth-lite"]),
+    max_steps: s.integer("Maximum agent steps; defaults to 32.", { minimum: 2, maximum: 128 }),
+    device: s.stringEnum("Browser device; defaults to desktop.", ["desktop", "mobile", "desktop-lg"]),
+    allowed_urls: s.nullable(s.array("Allowed URL glob patterns; omitted means unrestricted.", s.string("URL glob pattern, such as https://**.example.com/**."))),
+    enable_recording: s.boolean("Record the task; defaults to true."),
+    profile_id: s.nullable(profileId),
+    profile_read_only: s.boolean("Do not save browser changes to the profile; defaults to false."),
+    stealth_mode: s.boolean("Enable stealth mode; defaults to false."),
+    proxy_server: s.nullable(s.string("Remote proxy URL. Local self tunnels require a separate Smooth client.")),
+    proxy_username: s.nullable(s.string("Proxy authentication username.")),
+    proxy_password: s.nullable(s.string("Proxy authentication password.")),
+    certificates: s.nullable(s.array("Client certificates for secure websites.", s.object("Client certificate.", {
+        file: s.string("Base64-encoded p12 certificate."),
+        password: s.nullable(s.string("Certificate password.")),
+    }, { optional: ["password"] }))),
+    use_adblock: s.nullable(s.boolean("Enable ad blocking; defaults to true.")),
+    additional_tools: s.nullable(s.record("Built-in tool configurations, such as screenshot, hover or print_page.", s.nullable(s.looseObject("Tool configuration, or null for defaults.")))),
+    experimental_features: s.nullable(s.looseObject("Upstream experimental feature configuration.")),
+    extensions: s.nullable(s.array("Previously uploaded browser extension IDs.", s.string("Extension ID."))),
+    show_cursor: s.boolean("Show the mouse cursor; defaults to false."),
+};
+export const smoothActions = [
+    defineProviderAction("smooth", {
+        name: "submit_task",
+        operationType: "destructive",
+        requiredScopes: [],
+        description: "Submit a natural-language browser task to Smooth. The task may modify or delete data on visited sites. Uses account credits; returns immediately for result polling.",
+        asyncLifecycle: {
+            startActionId: "smooth.submit_task",
+            statusActionId: "smooth.get_task",
+            cancelActionId: "smooth.cancel_task",
+        },
+        inputSchema: s.object("One-shot browser task parameters.", {
+            task: s.nonEmptyString("Natural-language task to execute. Interactive sessions and custom tool callbacks are not supported by this action."),
+            ...taskOptions,
+        }, { optional: Object.keys(taskOptions) }),
+        outputSchema: taskOutput,
+    }),
+    defineProviderAction("smooth", {
+        name: "get_task",
+        operationType: "read",
+        requiredScopes: [],
+        description: "Get task status and results, including optional download URLs and events after a timestamp.",
+        asyncLifecycle: {
+            startActionId: "smooth.submit_task",
+            statusActionId: "smooth.get_task",
+            cancelActionId: "smooth.cancel_task",
+        },
+        inputSchema: s.object("Task lookup parameters.", {
+            task_id: taskId,
+            event_t: s.integer("Return events after this timestamp; defaults to zero."),
+            downloads: s.boolean("Include the download URL; defaults to false."),
+        }, { optional: ["event_t", "downloads"] }),
+        outputSchema: taskOutput,
+    }),
+    defineProviderAction("smooth", {
+        name: "list_tasks",
+        operationType: "read",
+        requiredScopes: [],
+        description: "List tasks, optionally paging to tasks created before a timestamp.",
+        inputSchema: s.object("Task list parameters.", {
+            t: s.integer("Return tasks created before this timestamp."),
+            l: s.integer("Result limit; defaults to 32.", { minimum: 1, maximum: 128 }),
+        }, { optional: ["t", "l"] }),
+        outputSchema: s.requiredObject("Task list.", {
+            tasks: s.array("Tasks in upstream order.", taskOutput),
+        }),
+    }),
+    defineProviderAction("smooth", {
+        name: "cancel_task",
+        operationType: "destructive",
+        requiredScopes: [],
+        description: "Cancel a running Smooth task.",
+        inputSchema: s.requiredObject("Task to cancel.", { task_id: taskId }),
+        outputSchema: success,
+    }),
+    defineProviderAction("smooth", {
+        name: "list_profiles",
+        operationType: "read",
+        requiredScopes: [],
+        description: "List reusable browser profiles.",
+        inputSchema: s.requiredObject("Profile list parameters.", {}),
+        outputSchema: s.requiredObject("Profile list.", {
+            profiles: s.array("Browser profiles.", profileOutput),
+        }),
+    }),
+    defineProviderAction("smooth", {
+        name: "create_profile",
+        operationType: "write",
+        requiredScopes: [],
+        description: "Create a browser profile to persist cookies and authentication across tasks.",
+        inputSchema: s.object("Profile creation parameters.", { id: s.nullable(profileId) }, { optional: ["id"] }),
+        outputSchema: profileOutput,
+    }),
+    defineProviderAction("smooth", {
+        name: "delete_profile",
+        operationType: "destructive",
+        requiredScopes: [],
+        description: "Delete a browser profile and its persisted browser state.",
+        inputSchema: s.requiredObject("Profile to delete.", { profile_id: profileId }),
+        outputSchema: success,
+    }),
+];

package/src/providers/smooth/executors.d.ts

@@ -0,0 +1,4 @@
+import type { CredentialValidators, ProviderExecutors, ProviderProxyExecutor } from "../../core/types.ts";
+export declare const executors: ProviderExecutors;
+export declare const credentialValidators: CredentialValidators;
+export declare const proxy: ProviderProxyExecutor;

package/src/providers/smooth/executors.js

@@ -0,0 +1,102 @@
+import { optionalRawString } from "../../core/cast.js";
+import { requiredInputString, requiredResponseRecord, ProviderRequestError, runProviderRequest, isAbortLikeError, defineApiKeyProviderExecutors, defineProviderProxy, mapProviderActionHandlers, readProviderProxyErrorMessage, withRetryAfterSeconds, } from "../provider-runtime.js";
+import { smoothActions } from "./actions.js";
+const baseUrl = "https://api.smooth.sh/api/v1";
+const defaultHeaders = { accept: "application/json" };
+async function request({ url, method, apiKey, body, fetcher, parentSignal }) {
+    return runProviderRequest({ signal: parentSignal, label: "Smooth" }, async (signal) => {
+        const response = await fetcher(url.toString(), {
+            method,
+            headers: { ...defaultHeaders, apikey: apiKey, "content-type": "application/json" },
+            body: body ? JSON.stringify(body) : undefined,
+            signal,
+        });
+        let payload;
+        try {
+            payload = requiredResponseRecord(await response.json(), "Smooth response");
+        }
+        catch (error) {
+            if (isAbortLikeError(error))
+                throw error;
+            throw new ProviderRequestError(response.ok ? 502 : response.status, "Smooth returned an invalid JSON response", undefined, "provider_error");
+        }
+        if (!response.ok) {
+            const detail = optionalRawString(payload.detail);
+            throw new ProviderRequestError(response.status, `Smooth request failed${detail ? `: ${detail.split(apiKey).join("[REDACTED]")}` : ""}`, undefined, "provider_error");
+        }
+        return payload.r;
+    });
+}
+const handlers = mapProviderActionHandlers("smooth", smoothActions, (action) => async (dataInput, context) => {
+    const values = dataInput;
+    const url = new URL(`${baseUrl}/${action.name.endsWith("profile") || action.name.endsWith("profiles") ? "profile" : "task"}`);
+    const id = values.task_id ?? values.profile_id;
+    if (action.name === "get_task" || action.name === "cancel_task" || action.name === "delete_profile") {
+        const segment = String(id);
+        if (segment === "." || segment === "..")
+            throw new ProviderRequestError(400, "Resource ID must not be a dot segment", undefined, "invalid_input");
+        url.pathname += `/${encodeURIComponent(segment)}`;
+    }
+    const method = action.name === "submit_task" || action.name === "create_profile"
+        ? "POST"
+        : action.name === "cancel_task" || action.name === "delete_profile"
+            ? "DELETE"
+            : "GET";
+    if (action.name === "get_task" || action.name === "list_tasks") {
+        for (const key of action.name === "get_task" ? ["event_t", "downloads"] : ["t", "l"]) {
+            if (values[key] !== undefined)
+                url.searchParams.set(key, String(values[key]));
+        }
+    }
+    const result = await request({
+        url: url,
+        method: method,
+        apiKey: context.apiKey,
+        body: method === "POST" ? values : undefined,
+        fetcher: context.fetcher,
+        parentSignal: context.signal,
+    });
+    if (action.name === "list_tasks" || action.name === "list_profiles") {
+        if (!Array.isArray(result))
+            throw new ProviderRequestError(502, "Smooth returned an invalid list", undefined, "provider_error");
+        return action.name === "list_tasks" ? { tasks: result } : { profiles: result };
+    }
+    if (method === "DELETE") {
+        if (typeof result !== "boolean")
+            throw new ProviderRequestError(502, "Smooth returned an invalid operation result", undefined, "provider_error");
+        return { success: result };
+    }
+    const object = requiredResponseRecord(result, "Smooth response result");
+    if (!optionalRawString(object.id)?.trim())
+        throw new ProviderRequestError(502, "Smooth response is missing an ID", undefined, "provider_error");
+    if (action.name !== "create_profile" && !optionalRawString(object.status)?.trim())
+        throw new ProviderRequestError(502, "Smooth task is missing status", undefined, "provider_error");
+    return object;
+});
+export const executors = defineApiKeyProviderExecutors("smooth", handlers, {
+    skipDnsValidation: true,
+});
+export const credentialValidators = {
+    async apiKey(input) {
+        requiredInputString(input.apiKey, "API Key");
+        return {
+            profile: { displayName: "Smooth API Key" },
+            grantedScopes: [],
+            metadata: { apiBaseUrl: baseUrl, validationMode: "local_non_empty_key" },
+        };
+    },
+};
+export const proxy = defineProviderProxy({
+    service: "smooth",
+    baseUrl,
+    auth: { type: "api_key_header", name: "apikey" },
+    skipDnsValidation: true,
+    customizeRequest({ headers }) {
+        for (const [name, value] of Object.entries({ accept: "application/json" }))
+            if (!headers.has(name))
+                headers.set(name, value);
+    },
+    async readError(response) {
+        return new ProviderRequestError(response.status, await readProviderProxyErrorMessage(response, "Provider request failed"), withRetryAfterSeconds(response), response.status === 429 ? "rate_limited" : "provider_error");
+    },
+});

package/src/providers/surf/actions.d.ts

@@ -0,0 +1,21 @@
+import type { ActionDefinition, JsonSchema } from "../../core/types.ts";
+export interface SurfRoute {
+    path: string;
+    method: string;
+    parameters: Array<{
+        name: string;
+        in: string;
+        field: string;
+    }>;
+    body: boolean;
+}
+export interface SurfActionDefinition {
+    name: string;
+    description: string;
+    operationType: ActionDefinition["operationType"];
+    route: SurfRoute;
+    inputSchema: JsonSchema;
+    outputSchema: JsonSchema;
+}
+export declare const surfRoutes: Record<string, SurfRoute>;
+export declare const surfActions: ActionDefinition[];

package/src/providers/surf/actions.js

@@ -0,0 +1,26 @@
+import { defineProviderAction } from "../../core/provider-definition.js";
+import { discoveryDefinitions } from "./discovery-definitions.js";
+import { equityDefinitions } from "./equity-definitions.js";
+import { marketDefinitions } from "./market-definitions.js";
+import { onchainDefinitions } from "./onchain-definitions.js";
+import { predictionDefinitions } from "./prediction-definitions.js";
+const actionLifecycles = {
+    onchain_sql_job_create: { startActionId: "surf.onchain_sql_job_create", statusActionId: "surf.onchain_sql_job_get" },
+};
+const definitions = [
+    ...marketDefinitions,
+    ...equityDefinitions,
+    ...discoveryDefinitions,
+    ...onchainDefinitions,
+    ...predictionDefinitions,
+];
+export const surfRoutes = Object.fromEntries(definitions.map((definition) => [definition.name, definition.route]));
+export const surfActions = definitions.map((definition) => defineProviderAction("surf", {
+    name: definition.name,
+    description: definition.description,
+    operationType: definition.operationType,
+    requiredScopes: [],
+    inputSchema: definition.inputSchema,
+    outputSchema: definition.outputSchema,
+    asyncLifecycle: actionLifecycles[definition.name],
+}));

package/src/providers/surf/discovery-definitions.d.ts

@@ -0,0 +1,2 @@
+import type { SurfActionDefinition } from "./actions.ts";
+export declare const discoveryDefinitions: SurfActionDefinition[];