@xata.io/client 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @xata.io/client
 
+## 0.5.0
+
+### Patch Changes
+
+- 14ec7d1: Fix in Selectable type
+
 ## 0.4.0
 
 ### Patch Changes

package/dist/schema/pagination.d.ts

@@ -1,5 +1,5 @@
-import { XataRecord } from '..';
 import { Query } from './query';
+import { XataRecord } from './record';
 export declare type PaginationQueryMeta = {
     page: {
         cursor: string;

package/dist/schema/query.d.ts

@@ -1,7 +1,8 @@
-import { Repository, XataRecord } from '..';
 import { ColumnsFilter, FilterExpression, PageConfig, SortExpression } from '../api/schemas';
 import { DeepConstraint, FilterConstraints, SortDirection, SortFilter } from './filters';
 import { Page, Paginable, PaginationOptions, PaginationQueryMeta } from './pagination';
+import { XataRecord } from './record';
+import { Repository } from './repository';
 import { Select, Selectable, SelectableColumn } from './selection';
 export declare type QueryOptions<T extends XataRecord> = {
     page?: PaginationOptions;

package/dist/schema/record.d.ts

@@ -8,6 +8,9 @@ export interface Identifiable {
      */
     id: string;
 }
+export interface BaseData {
+    [key: string]: any;
+}
 /**
  * Represents a persisted record from the database.
  */

package/dist/schema/repository.d.ts

@@ -1,45 +1,40 @@
 import { FetchImpl } from '../api/fetcher';
 import { Page } from './pagination';
 import { Query, QueryOptions } from './query';
-import { XataRecord } from './record';
-import { Select, Selectable, SelectableColumn } from './selection';
+import { BaseData, XataRecord } from './record';
+import { Select, SelectableColumn } from './selection';
 export declare type Links = Record<string, Array<string[]>>;
 /**
  * Common interface for performing operations on a table.
  */
-export declare abstract class Repository<T extends XataRecord> extends Query<T> {
-    /**
-     * Creates a record in the table.
-     * @param object Object containing the column names with their values to be stored in the table.
-     * @returns The full persisted record.
-     */
-    abstract create(object: Selectable<T>): Promise<T>;
+export declare abstract class Repository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record> {
+    abstract create(object: Data): Promise<Record>;
     /**
      * Creates multiple records in the table.
      * @param objects Array of objects with the column names and the values to be stored in the table.
      * @returns Array of the persisted records.
      */
-    abstract createMany(objects: Selectable<T>[]): Promise<T[]>;
+    abstract createMany(objects: Data[]): Promise<Record[]>;
     /**
      * Queries a single record from the table given its unique id.
      * @param id The unique id.
      * @returns The persisted record for the given id or null if the record could not be found.
      */
-    abstract read(id: string): Promise<T | null>;
+    abstract read(id: string): Promise<Record | null>;
     /**
      * Insert a single record with a unique id.
      * @param id The unique id.
      * @param object Object containing the column names with their values to be stored in the table.
      * @returns The full persisted record.
      */
-    abstract insert(id: string, object: Selectable<T>): Promise<T>;
+    abstract insert(id: string, object: Data): Promise<Record>;
     /**
      * Partially update a single record given its unique id.
      * @param id The unique id.
      * @param object The column names and their values that have to be updatd.
      * @returns The full persisted record.
      */
-    abstract update(id: string, object: Partial<Selectable<T>>): Promise<T>;
+    abstract update(id: string, object: Partial<Data>): Promise<Record>;
     /**
      * Updates or inserts a single record. If a record exists with the given id,
      * it will be update, otherwise a new record will be created.
@@ -47,36 +42,36 @@ export declare abstract class Repository<T extends XataRecord> extends Query<T>
      * @param object The column names and the values to be persisted.
      * @returns The full persisted record.
      */
-    abstract updateOrInsert(id: string, object: Selectable<T>): Promise<T>;
+    abstract updateOrInsert(id: string, object: Data): Promise<Record>;
     /**
      * Deletes a record given its unique id.
      * @param id The unique id.
      * @throws If the record could not be found or there was an error while performing the deletion.
      */
     abstract delete(id: string): void;
-    abstract query<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options: Options): Promise<Page<T, typeof options extends {
-        columns: SelectableColumn<T>[];
-    } ? Select<T, typeof options['columns'][number]> : R>>;
+    abstract query<Result extends XataRecord, Options extends QueryOptions<Record>>(query: Query<Record, Result>, options: Options): Promise<Page<Record, typeof options extends {
+        columns: SelectableColumn<Data>[];
+    } ? Select<Data, typeof options['columns'][number]> : Result>>;
 }
-export declare class RestRepository<T extends XataRecord> extends Repository<T> {
+export declare class RestRepository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Repository<Data, Record> {
     #private;
     constructor(client: BaseClient<any>, table: string);
-    create(object: Selectable<T>): Promise<T>;
-    createMany(objects: T[]): Promise<T[]>;
-    read(recordId: string): Promise<T | null>;
-    update(recordId: string, object: Partial<Selectable<T>>): Promise<T>;
-    insert(recordId: string, object: Selectable<T>): Promise<T>;
-    updateOrInsert(recordId: string, object: Selectable<T>): Promise<T>;
+    create(object: Data): Promise<Record>;
+    createMany(objects: Data[]): Promise<Record[]>;
+    read(recordId: string): Promise<Record | null>;
+    update(recordId: string, object: Partial<Data>): Promise<Record>;
+    insert(recordId: string, object: Data): Promise<Record>;
+    updateOrInsert(recordId: string, object: Data): Promise<Record>;
     delete(recordId: string): Promise<void>;
-    query<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options?: Options): Promise<Page<T, typeof options extends {
-        columns: SelectableColumn<T>[];
-    } ? Select<T, typeof options['columns'][number]> : R>>;
+    query<Result extends XataRecord, Options extends QueryOptions<Record>>(query: Query<Record, Result>, options?: Options): Promise<Page<Record, typeof options extends {
+        columns: SelectableColumn<Data>[];
+    } ? Select<Data, typeof options['columns'][number]> : Result>>;
 }
 interface RepositoryFactory {
-    createRepository<T extends XataRecord>(client: BaseClient<any>, table: string): Repository<T>;
+    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string): Repository<Data>;
 }
 export declare class RestRespositoryFactory implements RepositoryFactory {
-    createRepository<T extends XataRecord>(client: BaseClient<any>, table: string): Repository<T>;
+    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string): Repository<Data>;
 }
 declare type BranchStrategyValue = string | undefined | null;
 declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;

package/dist/schema/selection.d.ts

@@ -1,12 +1,10 @@
-import { XataRecord } from '..';
 import { StringKeys, UnionToIntersection, Values } from '../util/types';
 import { Query } from './query';
-import { Identifiable } from './record';
+import { BaseData, Identifiable, XataRecord } from './record';
 declare type Queries<T> = {
-    [key in keyof T as T[key] extends Query<any> ? key : never]: T[key];
+    [key in keyof T as T[key] extends Query<any, any> ? key : never]: T[key];
 };
-declare type InternalProperties = keyof XataRecord;
-export declare type Selectable<T extends XataRecord> = Omit<T, InternalProperties> & Identifiable;
+export declare type Selectable<T extends BaseData> = T & Partial<Identifiable>;
 export declare type SelectableColumn<O> = '*' | (O extends Array<unknown> ? never : O extends Record<string, any> ? '*' | Values<{
     [K in StringKeys<O>]: O[K] extends Record<string, any> ? `${K}.${SelectableColumn<O[K]>}` : K;
 }> : '');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xata.io/client",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Xata.io SDK for TypeScript and JavaScript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -20,5 +20,5 @@
     "url": "https://github.com/xataio/client-ts/issues"
   },
   "homepage": "https://github.com/xataio/client-ts/blob/main/client/README.md",
-  "gitHead": "d29cf06c96a17f69ca80c57b430059abc90fcad8"
+  "gitHead": "fddf861eb22287d5cf8e23761d5ae0d10c23d664"
 }