@xata.io/client 0.11.0 → 0.12.0

package/dist/index.d.ts

@@ -2873,7 +2873,7 @@ declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? V
 declare type MAX_RECURSION = 5;
 declare type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
     [K in DataProps<O>]: If<IsArray<RemoveNullable<O[K]>>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
-    If<IsObject<RemoveNullable<O[K]>>, RemoveNullable<O[K]> extends XataRecord ? SelectableColumn<RemoveNullable<O[K]>, [...RecursivePath, O[K]]> extends string ? K | `${K}.${SelectableColumn<RemoveNullable<O[K]>, [...RecursivePath, O[K]]>}` : never : `${K}.${StringKeys<RemoveNullable<O[K]>> | '*'}`, // This allows usage of objects that are not links
+    If<IsObject<RemoveNullable<O[K]>>, RemoveNullable<O[K]> extends XataRecord ? SelectableColumn<RemoveNullable<O[K]>, [...RecursivePath, O[K]]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : `${K}.${StringKeys<RemoveNullable<O[K]>> | '*'}`, // This allows usage of objects that are not links
     K>>;
 }>, never>;
 declare type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
@@ -2902,16 +2902,11 @@ interface BaseData {
 /**
  * Represents a persisted record from the database.
  */
-interface XataRecord extends Identifiable {
+interface XataRecord<ExtraMetadata extends Record<string, unknown> = Record<string, unknown>> extends Identifiable {
     /**
-     * Metadata of this record.
+     * Get metadata of this record.
      */
-    xata: {
-        /**
-         * Number that is increased every time the record is updated.
-         */
-        version: number;
-    };
+    getMetadata(): XataRecordMetadata & ExtraMetadata;
     /**
      * Retrieves a refreshed copy of the current record from the database.
      */
@@ -2919,7 +2914,7 @@ interface XataRecord extends Identifiable {
     /**
      * Performs a partial update of the current record. On success a new object is
      * returned and the current object is not mutated.
-     * @param data The columns and their values that have to be updated.
+     * @param partialUpdate The columns and their values that have to be updated.
      * @returns A new record containing the latest values for all the columns of the current record.
      */
     update(partialUpdate: Partial<EditableData<Omit<this, keyof XataRecord>>>): Promise<Readonly<SelectedPick<this, ['*']>>>;
@@ -2938,11 +2933,18 @@ declare type Link<Record extends XataRecord> = Omit<XataRecord, 'read' | 'update
     /**
      * Performs a partial update of the current record. On success a new object is
      * returned and the current object is not mutated.
-     * @param data The columns and their values that have to be updated.
+     * @param partialUpdate The columns and their values that have to be updated.
      * @returns A new record containing the latest values for all the columns of the current record.
      */
     update(partialUpdate: Partial<EditableData<Omit<Record, keyof XataRecord>>>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
 };
+declare type XataRecordMetadata = {
+    /**
+     * Number that is increased every time the record is updated.
+     */
+    version: number;
+    warnings?: string[];
+};
 declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
 declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
 declare type EditableData<O extends BaseData> = {
@@ -3114,17 +3116,27 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      *
      * ```
      * query.filter("columnName", columnValue)
-     * query.filter({
-     *   "columnName": columnValue
-     * })
+     * query.filter("columnName", operator(columnValue)) // Use gt, gte, lt, lte, startsWith,...
+     * ```
+     *
+     * @param column The name of the column to filter.
+     * @param value The value to filter.
+     * @returns A new Query object.
+     */
+    filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
+    /**
+     * Builds a new query object adding one or more constraints. Examples:
+     *
+     * ```
+     * query.filter({ "columnName": columnValue })
      * query.filter({
      *   "columnName": operator(columnValue) // Use gt, gte, lt, lte, startsWith,...
      * })
      * ```
      *
+     * @param filters A filter object
      * @returns A new Query object.
      */
-    filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
     filter(filters: Filter<Record>): Query<Record, Result>;
     /**
      * Builds a new query with a new sort option.
@@ -3139,45 +3151,114 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      * @returns A new Query object.
      */
     select<K extends SelectableColumn<Record>>(columns: NonEmptyArray<K>): Query<Record, SelectedPick<Record, NonEmptyArray<K>>>;
+    /**
+     * Get paginated results
+     *
+     * @returns A page of results
+     */
     getPaginated(): Promise<Page<Record, Result>>;
+    /**
+     * Get paginated results
+     *
+     * @param options Pagination options
+     * @returns A page of results
+     */
     getPaginated(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Page<Record, Result>>;
+    /**
+     * Get paginated results
+     *
+     * @param options Pagination options
+     * @returns A page of results
+     */
     getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
+    /**
+     * Get results in an iterator
+     *
+     * @async
+     * @returns Async interable of results
+     */
     [Symbol.asyncIterator](): AsyncIterableIterator<Result>;
+    /**
+     * Build an iterator of results
+     *
+     * @returns Async generator of results array
+     */
     getIterator(): AsyncGenerator<Result[]>;
+    /**
+     * Build an iterator of results
+     *
+     * @param options Pagination options with batchSize
+     * @returns Async generator of results array
+     */
     getIterator(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
         batchSize?: number;
     }): AsyncGenerator<Result[]>;
+    /**
+     * Build an iterator of results
+     *
+     * @param options Pagination options with batchSize
+     * @returns Async generator of results array
+     */
     getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
         batchSize?: number;
     }>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
     /**
      * Performs the query in the database and returns a set of results.
-     * @param options Additional options to be used when performing the query.
      * @returns An array of records from the database.
      */
     getMany(): Promise<Result[]>;
+    /**
+     * Performs the query in the database and returns a set of results.
+     * @param options Additional options to be used when performing the query.
+     * @returns An array of records from the database.
+     */
     getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Result[]>;
+    /**
+     * Performs the query in the database and returns a set of results.
+     * @param options Additional options to be used when performing the query.
+     * @returns An array of records from the database.
+     */
     getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
     /**
      * Performs the query in the database and returns all the results.
      * Warning: If there are a large number of results, this method can have performance implications.
-     * @param options Additional options to be used when performing the query.
      * @returns An array of records from the database.
      */
     getAll(): Promise<Result[]>;
+    /**
+     * Performs the query in the database and returns all the results.
+     * Warning: If there are a large number of results, this method can have performance implications.
+     * @param options Additional options to be used when performing the query.
+     * @returns An array of records from the database.
+     */
     getAll(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
         batchSize?: number;
     }): Promise<Result[]>;
+    /**
+     * Performs the query in the database and returns all the results.
+     * Warning: If there are a large number of results, this method can have performance implications.
+     * @param options Additional options to be used when performing the query.
+     * @returns An array of records from the database.
+     */
     getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
         batchSize?: number;
     }>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
     /**
      * Performs the query in the database and returns the first result.
-     * @param options Additional options to be used when performing the query.
      * @returns The first record that matches the query, or null if no record matched the query.
      */
     getFirst(): Promise<Result | null>;
+    /**
+     * Performs the query in the database and returns the first result.
+     * @param options Additional options to be used when performing the query.
+     * @returns The first record that matches the query, or null if no record matched the query.
+     */
     getFirst(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result | null>;
+    /**
+     * Performs the query in the database and returns the first result.
+     * @param options Additional options to be used when performing the query.
+     * @returns The first record that matches the query, or null if no record matched the query.
+     */
     getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
     /**
      * Builds a new query object adding a cache TTL in milliseconds.
@@ -3185,10 +3266,33 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      * @returns A new Query object.
      */
     cache(ttl: number): Query<Record, Result>;
+    /**
+     * Retrieve next page of records
+     *
+     * @returns A new page object.
+     */
     nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    /**
+     * Retrieve previous page of records
+     *
+     * @returns A new page object
+     */
     previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    /**
+     * Retrieve first page of records
+     *
+     * @returns A new page object
+     */
     firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    /**
+     * Retrieve last page of records
+     *
+     * @returns A new page object
+     */
     lastPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    /**
+     * @returns Boolean indicating if there is a next page
+     */
     hasNextPage(): boolean;
 }
 
@@ -3525,13 +3629,12 @@ declare class SearchPlugin<Schemas extends Record<string, BaseData>> extends Xat
     constructor(db: SchemaPluginResult<Schemas>);
     build({ getFetchProps }: XataPluginOptions): SearchPluginResult<Schemas>;
 }
-declare type SearchXataRecord = XataRecord & {
-    xata: {
-        table?: string;
-        highlight?: {
-            [key: string]: string[] | {
-                [key: string]: any;
-            };
+declare type SearchXataRecord = XataRecord<SearchExtraProperties>;
+declare type SearchExtraProperties = {
+    table: string;
+    highlight?: {
+        [key: string]: string[] | {
+            [key: string]: any;
         };
     };
 };

package/dist/index.mjs

@@ -1138,7 +1138,9 @@ function isIdentifiable(x) {
   return isObject(x) && isString(x?.id);
 }
 function isXataRecord(x) {
-  return isIdentifiable(x) && typeof x?.xata === "object" && typeof x?.xata?.version === "number";
+  const record = x;
+  const metadata = record?.getMetadata();
+  return isIdentifiable(x) && isObject(metadata) && typeof metadata.version === "number";
 }
 
 function isSortFilterString(value) {
@@ -1528,7 +1530,8 @@ const transformObjectLinks = (object) => {
 };
 const initObject = (db, schema, table, object) => {
   const result = {};
-  Object.assign(result, object);
+  const { xata, ...rest } = object ?? {};
+  Object.assign(result, rest);
   const { columns } = schema.tables.find(({ name }) => name === table) ?? {};
   if (!columns)
     console.error(`Table ${table} not found in schema`);
@@ -1536,10 +1539,10 @@ const initObject = (db, schema, table, object) => {
     const value = result[column.name];
     switch (column.type) {
       case "datetime": {
-        const date = new Date(value);
-        if (isNaN(date.getTime())) {
+        const date = value !== void 0 ? new Date(value) : void 0;
+        if (date && isNaN(date.getTime())) {
           console.error(`Failed to parse date ${value} for field ${column.name}`);
-        } else {
+        } else if (date) {
           result[column.name] = date;
         }
         break;
@@ -1564,7 +1567,10 @@ const initObject = (db, schema, table, object) => {
   result.delete = function() {
     return db[table].delete(result["id"]);
   };
-  for (const prop of ["read", "update", "delete"]) {
+  result.getMetadata = function() {
+    return xata;
+  };
+  for (const prop of ["read", "update", "delete", "getMetadata"]) {
     Object.defineProperty(result, prop, { enumerable: false });
   }
   Object.freeze(result);