refactor: iterative improvement of the API to match the server

Author: Lucas

libs/clients/client.ts

@@ -7,14 +7,13 @@ export type FnsConfig = {
   apiKey?: string;
   fetch?: typeof fetch;
 };
-export type Pagined<T> = {
-  data: T[];
+export type Pagination<T> = {
+  results: T[];
   hasMore: boolean;
   cursor: string;
 };
 export type PaginationParams<T> = T & {
-  ending_before?: string;
-  starting_after?: string;
+  cursor?: string;
   limit?: number;
 };
 export class BaseClient {

libs/clients/errors.ts

@@ -2,7 +2,7 @@ import {
   BaseClient,
   type FnsConfig,
   type PaginationParams,
-  type Pagined,
+  type Pagination,
 } from "./client.ts";
 
 type Error = {
@@ -26,18 +26,17 @@ export class ErrorsClient extends BaseClient {
    * @example
    * const errors = await fns.errors.list({ id: "..." })
    */
-  list(params: ErrorsListParams): Promise<Pagined<Error>> {
+  list(params: ErrorsListParams): Promise<Pagination<Error>> {
     const url = new URL(
       `/api/v1/errors/${params.execution_id}/${params.run_id}`,
       this.options.baseUrl,
     );
-    url.searchParams.set("limit", String(params.limit ?? 10));
-    if (params.ending_before) {
-      url.searchParams.set("ending_before", params.ending_before);
+    if (params.limit) {
+      url.searchParams.set("limit", String(params.limit));
     }
-    if (params.starting_after) {
-      url.searchParams.set("starting_after", params.starting_after);
+    if (params.cursor) {
+      url.searchParams.set("cursor", params.cursor);
     }
-    return this.request<Pagined<Error>>(url, "GET");
+    return this.request<Pagination<Error>>(url, "GET");
   }
 }

libs/clients/executions.ts

@@ -2,10 +2,10 @@ import {
   BaseClient,
   type FnsConfig,
   type PaginationParams,
-  type Pagined,
+  type Pagination,
 } from "./client.ts";
 
-type Execution = {
+export type Execution = {
   id: string;
   name: string;
   data: { size: number } | null;
@@ -14,43 +14,39 @@ type Execution = {
   created_at: string;
   updated_at: string;
 };
-type ExecutionInvokeParams = {
+export type ExecutionInvokeParams = {
   id?: string;
   name: string;
   data: unknown;
   wait?: boolean;
   idempotencyKey?: string;
 };
-type ExecutionTriggerParams = {
+export type ExecutionTriggerParams = {
   id: string;
   signal: string;
   data?: unknown;
   idempotencyKey?: string;
 };
-type ExecutionAbortParams = {
+export type ExecutionAbortParams = {
   id: string;
 };
-type ExecutionPauseParams = {
+export type ExecutionPauseParams = {
   id: string;
   idempotencyKey?: string;
 };
-type ExecutionResumeParams = {
+export type ExecutionResumeParams = {
   id: string;
   idempotencyKey?: string;
 };
-type ExecutionResultParams = {
+export type ExecutionResultParams = {
   id: string;
 };
-type ExecutionDataParams = {
+export type ExecutionDataParams = {
   id: string;
 };
-type ExecutionListParams = PaginationParams<{
-  created?: {
-    gt?: string;
-    gte?: string;
-    lt?: string;
-    lte?: string;
-  };
+export type ExecutionListParams = PaginationParams<{
+  status?: "running" | "waiting" | "completed" | "failed" | "aborted";
+  name?: string;
 }>;
 
 export class ExecutionsClient extends BaseClient {
@@ -62,30 +58,23 @@ export class ExecutionsClient extends BaseClient {
    * @example
    * const executions = await fns.executions.list()
    */
-  list(params: ExecutionListParams): Promise<Pagined<Execution>> {
+  list(params?: ExecutionListParams): Promise<Pagination<Execution>> {
     const url = new URL("/api/v1/executions", this.options.baseUrl);
-    url.searchParams.set("limit", String(params.limit ?? 10));
-    if (params.ending_before) {
-      url.searchParams.set("ending_before", params.ending_before);
-    }
-    if (params.starting_after) {
-      url.searchParams.set("starting_after", params.starting_after);
-    }
-    if (params.created) {
-      if (params.created.gt) {
-        url.searchParams.set("created[gt]", params.created.gt);
+    if (params) {
+      if (params.limit) {
+        url.searchParams.set("limit", String(params.limit));
       }
-      if (params.created.gte) {
-        url.searchParams.set("created[gte]", params.created.gte);
+      if(params.status) {
+        url.searchParams.set("status", params.status);
       }
-      if (params.created.lt) {
-        url.searchParams.set("created[lt]", params.created.lt);
+      if(params.name) {
+        url.searchParams.set("name", params.name);
       }
-      if (params.created.lte) {
-        url.searchParams.set("created[lte]", params.created.lte);
+      if (params.cursor) {
+        url.searchParams.set("cursor", params.cursor);
       }
     }
-    return this.request<Pagined<Execution>>(url, "GET");
+    return this.request<Pagination<Execution>>(url, "GET");
   }
 
   /**

libs/clients/queries.ts

@@ -2,27 +2,26 @@ import {
   BaseClient,
   type FnsConfig,
   type PaginationParams,
-  type Pagined,
+  type Pagination,
 } from "./client.ts";
 
-type Query = {
+export type Query = {
   name: string;
   size: number;
   version: number;
   updated_at: string;
 };
-type QueryValue<T> = {
+export type QueryValue<T> = {
   value: T;
   timestamp: string;
   version: number;
-
   updated_at: string;
 };
-type QueryRetrieveParams = {
+export type QueryRetrieveParams = {
   id: string;
   query: string;
 };
-type QueryListParams = PaginationParams<{
+export type QueryListParams = PaginationParams<{
   execution_id: string;
 }>;
 
@@ -35,19 +34,18 @@ export class QueriesClient extends BaseClient {
    * @example
    * const queries = await fns.queries.list({ id: "..." })
    */
-  list(params: QueryListParams): Promise<Pagined<Query>> {
+  list(params: QueryListParams): Promise<Pagination<Query>> {
     const url = new URL(
       `/api/v1/queries/${params.execution_id}`,
       this.options.baseUrl,
     );
-    url.searchParams.set("limit", String(params.limit ?? 10));
-    if (params.ending_before) {
-      url.searchParams.set("ending_before", params.ending_before);
+    if (params.limit) {
+      url.searchParams.set("limit", String(params.limit));
     }
-    if (params.starting_after) {
-      url.searchParams.set("starting_after", params.starting_after);
+    if (params.cursor) {
+      url.searchParams.set("cursor", params.cursor);
     }
-    return this.request<Pagined<Query>>(url, "GET");
+    return this.request<Pagination<Query>>(url, "GET");
   }
 
   /**

libs/clients/runs.ts

@@ -2,26 +2,22 @@ import {
   BaseClient,
   type FnsConfig,
   type PaginationParams,
-  type Pagined,
+  type Pagination,
 } from "./client.ts";
-type Query = {
-  name: string;
-  size: number;
-  version: number;
-  updated_at: string;
-};
-type QueryValue<T> = {
-  value: T;
-  timestamp: string;
-  version: number;
 
+export type Run = {
+  tenant_id: string;
+  execution_id: string;
+  id: string;
+  status: "running" | "completed" | "failed" | "aborted";
+  created_at: string;
   updated_at: string;
 };
-type QueryRetrieveParams = {
+export type RunRetrieveParams = {
   id: string;
-  query: string;
+  execution_id: string;
 };
-type QueryListParams = PaginationParams<{
+export type RunListParams = PaginationParams<{
   execution_id: string;
 }>;
 
@@ -30,46 +26,33 @@ export class RunsClient extends BaseClient {
     super(config);
   }
   /**
-   * List all queries of an execution.
+   * List all runs of an execution.
    * @example
-   * const queries = await fns.queries.list({ id: "..." })
+   * const runs = await fns.runs.list({ execution_id: "..." })
    */
-  list(params: QueryListParams): Promise<Pagined<Query>> {
+  list(params: RunListParams): Promise<Pagination<Run>> {
     const url = new URL(
-      `/api/v1/queries/${params.execution_id}`,
+      `/api/v1/runs/${params.execution_id}`,
       this.options.baseUrl,
     );
-    url.searchParams.set("limit", String(params.limit ?? 10));
-    if (params.ending_before) {
-      url.searchParams.set("ending_before", params.ending_before);
+    if (params.limit) {
+      url.searchParams.set("limit", String(params.limit));
     }
-    if (params.starting_after) {
-      url.searchParams.set("starting_after", params.starting_after);
+    if (params.cursor) {
+      url.searchParams.set("cursor", params.cursor);
     }
-    return this.request<Pagined<Query>>(url, "GET");
+    return this.request<Pagination<Run>>(url, "GET");
   }
 
   /**
-   * Retrieve a specific query by its ID.
+   * Retrieve a specific run by its ID.
    * @example
-   * const value = await fns.queries.retrieve({ id: "...", query: "..." })
+   * const value = await fns.runs.retrieve({ execution_id: "...", id: "..." })
    */
-  retrieve<T = unknown>(params: QueryRetrieveParams): Promise<QueryValue<T>> {
-    return this.request<QueryValue<T>>(
-      `/api/v1/queries/${params.id}/${params.query}`,
+  retrieve(params: RunRetrieveParams): Promise<Run> {
+    return this.request<Run>(
+      `/api/v1/runs/${params.execution_id}/${params.id}`,
       "GET",
     );
   }
-}
-
-/*
-
-queries.get()
-queries.list()
-
-steps.get()
-steps.list()
-
-errors.get()
-errors.list()
-*/
+}