Cursor refactors & alignment (#76)

* various cursor tweaks & fixes

* minor typing tweaks

* fixed bug with filter being potentially muitable

* made cursors immutable

* some tests not all idk

Author: toptobes

src/db/types/collections/collections-common.ts

@@ -192,4 +192,3 @@ export interface DefaultIdOptions {
    */
   type: 'uuid' | 'uuidv6' | 'uuidv7' | 'objectId';
 }
-

src/documents/commands/command-impls.ts

@@ -190,7 +190,10 @@ export class CommandImpls<ID> {
   }
 
   public find<Schema extends SomeDoc>(keyspace: string, filter: SomeDoc, options?: GenericFindOptions): FindCursor<Schema, Schema> {
-    return new FindCursor(keyspace, this.#httpClient, filter, options);
+    if (options?.sort) {
+      options.sort = normalizedSort(options.sort);
+    }
+    return new FindCursor(keyspace, this.#httpClient, structuredClone(filter), structuredClone(options));
   }
 
   public async findOne<Schema>(filter: SomeDoc, options?: GenericFindOneOptions): Promise<Schema | null> {

src/documents/cursor.ts

@@ -240,40 +240,6 @@ export class TooManyDocumentsToCountError extends DataAPIError {
   }
 }
 
-/**
- * Caused by trying to perform an operation on an already-initialized {@link FindCursor} that requires it to be
- * uninitialized.
- *
- * If you run into this error, and you really do need to change an option on the cursor, you can rewind the cursor
- * using {@link FindCursor.rewind}, or clone it using {@link FindCursor.clone}.
- *
- * @example
- * ```typescript
- * await collections.find({}).toArray();
- *
- * try {
- *   await cursor.limit(10);
- * } catch (e) {
- *   if (e instanceof CursorIsStartedError) {
- *     console.log(e.message); // "Cursor is already initialized..."
- *   }
- * }
- * ```
- *
- * @public
- */
-export class CursorIsStartedError extends DataAPIError {
-  /**
-   * Should not be instantiated by the user.
-   *
-   * @internal
-   */
-  constructor(message: string) {
-    super(message);
-    this.name = 'CursorIsStartedError';
-  }
-}
-
 /**
  * An error representing the *complete* errors for an operation. This is a cohesive error that represents all the
  * errors that occurred during a single operation, and should not be thought of as *always* 1:1 with the number of

src/documents/errors.ts

@@ -27,7 +27,6 @@ export {
   DataAPIHttpError,
   DataAPITimeoutError,
   CumulativeDataAPIError,
-  CursorIsStartedError,
   DataAPIDetailedErrorDescriptor,
   DataAPIError,
   DataAPIErrorDescriptor,

src/documents/index.ts

@@ -15,4 +15,4 @@
 export * from './api';
 export * from './token-providers';
 export { DataAPIEnvironments } from './constants';
-export type { nullish, WithTimeout, DataAPIEnvironment } from './types';
+export type { nullish, WithTimeout, DataAPIEnvironment, DeepPartial } from './types';

src/documents/tables/test.ts

@@ -51,3 +51,12 @@ export type Ref<T> = { ref: T }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Used for when intersection w/ {} is a "noop"
 export type EmptyObj = {};
+
+/**
+ * Recursively makes all properties of a type optional.
+ *
+ * @public
+ */
+export type DeepPartial<T> = T extends object ? {
+  [P in keyof T]?: DeepPartial<T[P]>;
+} : T;

src/lib/index.ts

@@ -61,7 +61,7 @@ parallel('integration.documents.collections.delete-many', { truncateColls: 'both
     } catch (e) {
       assert.ok(e instanceof Error);
       assert.ok(!(e instanceof DataAPIError));
-      assert.strictEqual(e.message, 'test');
+      assert.strictEqual(e.message, 'failing_client');
     }
   });
 });

src/lib/types.ts

@@ -153,7 +153,7 @@ parallel('integration.documents.collections.insert-many', { truncateColls: 'defa
     } catch (e) {
       assert.ok(e instanceof Error);
       assert.ok(!(e instanceof DataAPIError));
-      assert.strictEqual(e.message, 'test');
+      assert.strictEqual(e.message, 'failing_client');
     }
   });
 
@@ -165,7 +165,7 @@ parallel('integration.documents.collections.insert-many', { truncateColls: 'defa
     } catch (e) {
       assert.ok(e instanceof Error);
       assert.ok(!(e instanceof DataAPIError));
-      assert.strictEqual(e.message, 'test');
+      assert.strictEqual(e.message, 'failing_client');
     }
   });
 

tests/integration/documents/collections/delete-many.test.ts

@@ -790,7 +790,7 @@ parallel('integration.documents.collections.update-many', { truncateColls: 'defa
     } catch (e) {
       assert.ok(e instanceof Error);
       assert.ok(!(e instanceof DataAPIError));
-      assert.strictEqual(e.message, 'test');
+      assert.strictEqual(e.message, 'failing_client');
     }
   });
 });