fix: correct crawl SDK bugs and add missing CRUD wrappers

The crawl module had several copy-paste bugs from the datasets module:

- JSDoc on getCrawlsForDataset said "create a dataset"
- Return type was Promise<Dataset> instead of Promise<Array<CrawlRequest>>
- Error message referenced "create a crawl" on a GET operation

The SDK was also missing wrappers for the createCrawl, updateCrawl, and
deleteCrawl endpoints that already exist in the OpenAPI spec.

Changes:

- Fix JSDoc, return type, and error message on getCrawlsForDataset
- Make the props argument optional (limit/page are both optional)
- Add createCrawl, updateCrawl, and deleteCrawl wrappers
- Add a basic crawl.test.ts that exercises getCrawlsForDataset

Author: sushaan-k

clients/ts-sdk/src/functions/crawl/crawl.test.ts

@@ -0,0 +1,21 @@
+import { beforeAll, describe, expectTypeOf } from "vitest";
+import { TrieveSDK } from "../../sdk";
+import { CrawlRequest } from "../../types.gen";
+import { TRIEVE } from "../../__tests__/constants";
+import { test } from "../../__tests__/utils";
+
+describe("Crawl Tests", async () => {
+  let trieve: TrieveSDK;
+  beforeAll(() => {
+    trieve = TRIEVE;
+  });
+
+  test("getCrawlsForDataset", async () => {
+    const data = await trieve.getCrawlsForDataset({
+      page: 1,
+      limit: 10,
+    });
+
+    expectTypeOf(data).toEqualTypeOf<Array<CrawlRequest>>();
+  });
+});

clients/ts-sdk/src/functions/crawl/index.ts

@@ -7,39 +7,137 @@
 import { TrieveSDK } from "../../sdk";
 import {
   $OpenApiTs,
-  Dataset,
+  CreateCrawlReqPayload,
+  CrawlRequest,
   GetCrawlRequestsForDatasetData,
+  UpdateCrawlReqPayload,
 } from "../../types.gen";
 
 /**
- * Function that provides the ability to create a dataset. This function is used to create a new dataset in the organization.
+ * Function that retrieves all crawl requests for the current dataset, with optional pagination.
  *
  * Example:
  * ```js
- * const dataset = await trieve.createDataset({
- *  dataset_name: "My Dataset",
+ * const crawls = await trieve.getCrawlsForDataset({
+ *   page: 1,
+ *   limit: 10,
  * });
  * ```
  */
 export async function getCrawlsForDataset(
   /** @hidden */
   this: TrieveSDK,
-  props: GetCrawlRequestsForDatasetData,
+  props: Omit<GetCrawlRequestsForDatasetData, "trDataset"> = {},
   signal?: AbortSignal,
-): Promise<Dataset> {
+): Promise<Array<CrawlRequest>> {
   if (!this.datasetId) {
-    throw new Error("Dataset ID is required to create a crawl");
+    throw new Error("Dataset ID is required to get crawls");
   }
 
   return this.trieve.fetch<"eject">(
     `/api/crawl?limit=${props.limit ?? 10}&page=${
       props.page ?? 1
     }` as keyof $OpenApiTs,
     "get",
+    {
+      datasetId: this.datasetId,
+    },
+    signal,
+  ) as Promise<Array<CrawlRequest>>;
+}
+
+/**
+ * Function that creates a new crawl request for the current dataset.
+ *
+ * Example:
+ * ```js
+ * const crawl = await trieve.createCrawl({
+ *   crawl_options: {
+ *     site_url: "https://example.com",
+ *   },
+ * });
+ * ```
+ */
+export async function createCrawl(
+  /** @hidden */
+  this: TrieveSDK,
+  props: CreateCrawlReqPayload,
+  signal?: AbortSignal,
+): Promise<CrawlRequest> {
+  if (!this.datasetId) {
+    throw new Error("Dataset ID is required to create a crawl");
+  }
+
+  return this.trieve.fetch(
+    "/api/crawl",
+    "post",
     {
       data: props,
       datasetId: this.datasetId,
     },
     signal,
-  ) as Promise<Dataset>;
+  ) as Promise<CrawlRequest>;
+}
+
+/**
+ * Function that updates an existing crawl request for the current dataset.
+ *
+ * Example:
+ * ```js
+ * const crawl = await trieve.updateCrawl({
+ *   crawl_id: "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+ *   crawl_options: {
+ *     site_url: "https://example.com",
+ *   },
+ * });
+ * ```
+ */
+export async function updateCrawl(
+  /** @hidden */
+  this: TrieveSDK,
+  props: UpdateCrawlReqPayload,
+  signal?: AbortSignal,
+): Promise<CrawlRequest> {
+  if (!this.datasetId) {
+    throw new Error("Dataset ID is required to update a crawl");
+  }
+
+  return this.trieve.fetch(
+    "/api/crawl",
+    "put",
+    {
+      data: props,
+      datasetId: this.datasetId,
+    },
+    signal,
+  ) as Promise<CrawlRequest>;
+}
+
+/**
+ * Function that deletes a crawl request for the current dataset by its ID.
+ *
+ * Example:
+ * ```js
+ * await trieve.deleteCrawl("3c90c3cc-0d44-4b50-8888-8dd25736052a");
+ * ```
+ */
+export async function deleteCrawl(
+  /** @hidden */
+  this: TrieveSDK,
+  crawlId: string,
+  signal?: AbortSignal,
+): Promise<void> {
+  if (!this.datasetId) {
+    throw new Error("Dataset ID is required to delete a crawl");
+  }
+
+  return this.trieve.fetch(
+    "/api/crawl/{crawl_id}",
+    "delete",
+    {
+      crawlId,
+      datasetId: this.datasetId,
+    },
+    signal,
+  ) as Promise<void>;
 }