fix: improved api client for first gui draft

Author: Lucas

libs/clients/client.ts

@@ -1,4 +1,5 @@
-import { assert, assertExists } from "../../deps.ts";
+import { assert } from "../../deps.ts";
+import { ApiKeyRequiredError } from "../errors.ts";
 
 export type FnsConfig = {
   dev?: boolean;
@@ -27,7 +28,7 @@ export class BaseClient {
     body?: unknown,
     idempotencyKey?: string | null,
   ): Promise<T> {
-    assertExists(this.options.apiKey, "apiKey is required");
+    if (!this.options.apiKey) throw new ApiKeyRequiredError();
     assert(typeof this.options.apiKey === "string", "apiKey must be a string");
     const parsedURL = url instanceof URL
       ? url
@@ -42,7 +43,10 @@ export class BaseClient {
       },
       body: body ? JSON.stringify(body) : null,
     });
-    if (!res.ok) throw new Error(`Failed to fetch ${parsedURL.pathname}`);
+    if (!res.ok) {
+      const error = await res.text();
+      throw new Error(error);
+    }
     return await res.json() as T;
   }
 }

libs/clients/errors.ts

@@ -24,11 +24,11 @@ export class ErrorsClient extends BaseClient {
   /**
    * List all errors of a run
    * @example
-   * const errors = await fns.errors.list({ id: "..." })
+   * const errors = await fns.errors.list({ execution_id: "...", run_id: "..." });
    */
   list(params: ErrorsListParams): Promise<Pagination<Error>> {
     const url = new URL(
-      `/api/v1/errors/${params.execution_id}/${params.run_id}`,
+      `/v1/errors/${params.execution_id}/${params.run_id}`,
       this.options.baseUrl,
     );
     if (params.limit) {

libs/clients/executions.ts

@@ -14,10 +14,13 @@ export type Execution = {
   created_at: string;
   updated_at: string;
 };
+export type ExecutionRetrieveParams = {
+  id: string;
+};
 export type ExecutionInvokeParams = {
   id?: string;
   name: string;
-  data: unknown;
+  data?: unknown | null;
   wait?: boolean;
   idempotencyKey?: string;
 };
@@ -59,7 +62,7 @@ export class ExecutionsClient extends BaseClient {
    * const executions = await fns.executions.list()
    */
   list(params?: ExecutionListParams): Promise<Pagination<Execution>> {
-    const url = new URL("/api/v1/executions", this.options.baseUrl);
+    const url = new URL("/v1/executions", this.options.baseUrl);
     if (params) {
       if (params.limit) {
         url.searchParams.set("limit", String(params.limit));
@@ -80,10 +83,10 @@ export class ExecutionsClient extends BaseClient {
   /**
    * Retrieve a specific execution by its ID.
    * @example
-   * const execution = await fns.executions.retrieve("id")
+   * const execution = await fns.executions.retrieve({ id: "..." })
    */
-  retrieve(id: string): Promise<Execution> {
-    return this.request<Execution>(`/api/v1/executions/${id}`, "GET");
+  retrieve(params: ExecutionRetrieveParams): Promise<Execution> {
+    return this.request<Execution>(`/v1/executions/${params.id}`, "GET");
   }
 
   /**
@@ -99,7 +102,7 @@ export class ExecutionsClient extends BaseClient {
     params: ExecutionInvokeParams,
   ): Promise<T | Execution> {
     const execution = await this.request<Execution>(
-      "/api/v1/executions",
+      "/v1/executions",
       "POST",
       params,
     );
@@ -116,7 +119,7 @@ export class ExecutionsClient extends BaseClient {
    */
   trigger(params: ExecutionTriggerParams): Promise<void> {
     return this.request<void>(
-      `/api/v1/executions/${params.id}/trigger`,
+      `/v1/executions/${params.id}/trigger`,
       "POST",
       params.data ?? null,
       params.idempotencyKey,
@@ -130,19 +133,19 @@ export class ExecutionsClient extends BaseClient {
    */
   abort(params: ExecutionAbortParams): Promise<Execution> {
     return this.request<Execution>(
-      `/api/v1/executions/${params.id}/abort`,
+      `/v1/executions/${params.id}/abort`,
       "POST",
     );
   }
 
   /**
    * Pause an execution.
    * @example
-   * const execution = await fns.executions.pause("id")
+   * const execution = await fns.executions.pause({ id: "..." })
    */
   pause(params: ExecutionPauseParams): Promise<Execution> {
     return this.request<Execution>(
-      `/api/v1/executions/${params.id}/pause`,
+      `/v1/executions/${params.id}/pause`,
       "POST",
       null,
       params.idempotencyKey,
@@ -152,11 +155,11 @@ export class ExecutionsClient extends BaseClient {
   /**
    * Resume an execution.
    * @example
-   * const execution = await fns.executions.resume("id")
+   * const execution = await fns.executions.resume({ id: "..." })
    */
   resume(params: ExecutionResumeParams): Promise<Execution> {
     return this.request<Execution>(
-      `/api/v1/executions/${params.id}/resume`,
+      `/v1/executions/${params.id}/resume`,
       "POST",
       null,
       params.idempotencyKey,
@@ -166,10 +169,10 @@ export class ExecutionsClient extends BaseClient {
   /**
    * Get or wait for the result of an execution.
    * @example
-   * const result = await fns.executions.result("id")
+   * const result = await fns.executions.result({ id: "..." })
    */
   result<T = unknown>(params: ExecutionResultParams): Promise<T> {
-    return this.request<T>(`/api/v1/executions/${params.id}/result`, "GET");
+    return this.request<T>(`/v1/executions/${params.id}/result`, "GET");
   }
 
   /**
@@ -178,6 +181,6 @@ export class ExecutionsClient extends BaseClient {
    * const data = await fns.executions.data({ id: "..." })
    */
   data<T = unknown>(params: ExecutionDataParams): Promise<T> {
-    return this.request<T>(`/api/v1/executions/${params.id}/data`, "GET");
+    return this.request<T>(`/v1/executions/${params.id}/data`, "GET");
   }
 }

libs/clients/queries.ts

@@ -36,7 +36,7 @@ export class QueriesClient extends BaseClient {
    */
   list(params: QueryListParams): Promise<Pagination<Query>> {
     const url = new URL(
-      `/api/v1/queries/${params.execution_id}`,
+      `/v1/queries/${params.execution_id}`,
       this.options.baseUrl,
     );
     if (params.limit) {
@@ -55,7 +55,7 @@ export class QueriesClient extends BaseClient {
    */
   retrieve<T = unknown>(params: QueryRetrieveParams): Promise<QueryValue<T>> {
     return this.request<QueryValue<T>>(
-      `/api/v1/queries/${params.id}/${params.query}`,
+      `/v1/queries/${params.id}/${params.query}`,
       "GET",
     );
   }

libs/clients/runs.ts

@@ -32,7 +32,7 @@ export class RunsClient extends BaseClient {
    */
   list(params: RunListParams): Promise<Pagination<Run>> {
     const url = new URL(
-      `/api/v1/runs/${params.execution_id}`,
+      `/v1/runs/${params.execution_id}`,
       this.options.baseUrl,
     );
     if (params.limit) {
@@ -51,7 +51,7 @@ export class RunsClient extends BaseClient {
    */
   retrieve(params: RunRetrieveParams): Promise<Run> {
     return this.request<Run>(
-      `/api/v1/runs/${params.execution_id}/${params.id}`,
+      `/v1/runs/${params.execution_id}/${params.id}`,
       "GET",
     );
   }

libs/clients/steps.ts

@@ -37,7 +37,7 @@ export class StepsClient extends BaseClient {
    */
   list(params: StepListParams): Promise<Pagination<Step>> {
     const url = new URL(
-      `/api/v1/steps/${params.execution_id}`,
+      `/v1/steps/${params.execution_id}`,
       this.options.baseUrl,
     );
     if (params.limit) {
@@ -56,7 +56,7 @@ export class StepsClient extends BaseClient {
    */
   retrieve(params: StepRetrieveParams): Promise<Step> {
     return this.request<Step>(
-      `/api/v1/steps/${params.execution_id}/${params.id}`,
+      `/v1/steps/${params.execution_id}/${params.id}`,
       "GET",
     );
   }

libs/errors.ts

@@ -26,6 +26,13 @@ export class SigningKeyRequiredError extends NonRetriableError {
     this.name = "SigningKeyRequiredError";
   }
 }
+export class ApiKeyRequiredError extends Error {
+  constructor(message?: string) {
+    super(message);
+    Object.setPrototypeOf(this, ApiKeyRequiredError.prototype);
+    this.name = "ApiKeyRequiredError";
+  }
+}
 export class FunctionNotFoundError extends NonRetriableError {
   constructor(message?: string) {
     super(message);

libs/index.ts

@@ -91,11 +91,11 @@ export class Fns {
   ): Promise<FnsResponse> {
     const definition = this.definitions.get(event.name);
     if (!definition) throw new Error(`Function ${event.name} not found`);
-    if (definition.version !== event.version) {
+    /*if (definition.version !== event.version) {
       throw new Error(
         `Function ${event.name} version ${definition.version} mismatch with request version ${event.version}`,
       );
-    }
+    }*/
     const output = await this.engine(event, definition.fn, abortSignal);
     return output as FnsResponse;
   }