@xata.io/client 0.0.0-alpha.ed1ba7e → 0.0.0-beta.18f8d57

package/dist/index.d.ts

@@ -8,10 +8,10 @@ export interface XataRecord {
     delete(): Promise<void>;
 }
 export 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<infer A, infer B> ? key : never]: T[key];
 };
 export declare type OmitQueries<T> = {
-    [key in keyof T as T[key] extends Query<any> ? never : key]: T[key];
+    [key in keyof T as T[key] extends Query<infer A, infer B> ? never : key]: T[key];
 };
 export declare type OmitLinks<T> = {
     [key in keyof T as T[key] extends XataRecord ? never : key]: T[key];
@@ -20,17 +20,11 @@ export declare type OmitMethods<T> = {
     [key in keyof T as T[key] extends Function ? never : key]: T[key];
 };
 export declare type Selectable<T> = Omit<OmitQueries<OmitMethods<T>>, 'id' | 'xata'>;
-export declare type SelectableColumn<T> = keyof Selectable<T> | '*';
-export declare type Select<T, K extends SelectableColumn<T>> = (K extends keyof T ? Pick<T, K> : T) & Queries<T> & XataRecord;
+export declare type Select<T, K extends keyof T> = Pick<T, K> & Queries<T> & XataRecord;
 export declare type Include<T> = {
     [key in keyof T as T[key] extends XataRecord ? key : never]?: boolean | Array<keyof Selectable<T[key]>>;
 };
 declare type SortDirection = 'asc' | 'desc';
-declare type SortFilterExtended<T> = {
-    column: keyof T;
-    direction?: SortDirection;
-};
-declare type SortFilter<T> = SortFilterExtended<T> | keyof T;
 declare type Operator = '$gt' | '$lt' | '$ge' | '$le' | '$exists' | '$notExists' | '$endsWith' | '$startsWith' | '$pattern' | '$is' | '$isNot' | '$contains' | '$includes' | '$includesSubstring' | '$includesPattern' | '$includesAll';
 declare type Constraint<T> = {
     [key in Operator]?: T;
@@ -75,17 +69,15 @@ declare type OffsetNavigationOptions = {
 declare type PaginationOptions = CursorNavigationOptions & OffsetNavigationOptions;
 declare type BulkQueryOptions<T> = {
     page?: PaginationOptions;
-    columns?: Array<keyof Selectable<T>>;
-    sort?: SortFilter<T> | SortFilter<T>[];
 };
-declare type QueryOrConstraint<T extends XataRecord, R extends XataRecord> = Query<T, R> | Constraint<T>;
+declare type QueryOrConstraint<T, R> = Query<T, R> | Constraint<T>;
 declare type QueryMeta = {
     page: {
         cursor: string;
         more: boolean;
     };
 };
-interface BasePage<T extends XataRecord, R extends XataRecord> {
+interface BasePage<T, R> {
     query: Query<T, R>;
     meta: QueryMeta;
     records: R[];
@@ -95,7 +87,7 @@ interface BasePage<T extends XataRecord, R extends XataRecord> {
     lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
     hasNextPage(): boolean;
 }
-declare class Page<T extends XataRecord, R extends XataRecord> implements BasePage<T, R> {
+declare class Page<T, R> implements BasePage<T, R> {
     readonly query: Query<T, R>;
     readonly meta: QueryMeta;
     readonly records: R[];
@@ -106,7 +98,7 @@ declare class Page<T extends XataRecord, R extends XataRecord> implements BasePa
     lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
     hasNextPage(): boolean;
 }
-export declare class Query<T extends XataRecord, R extends XataRecord = T> implements BasePage<T, R> {
+export declare class Query<T, R = T> implements BasePage<T, R> {
     table: string;
     repository: Repository<T>;
     readonly $any?: QueryOrConstraint<T, R>[];
@@ -114,7 +106,6 @@ export declare class Query<T extends XataRecord, R extends XataRecord = T> imple
     readonly $not?: QueryOrConstraint<T, R>[];
     readonly $none?: QueryOrConstraint<T, R>[];
     readonly $sort?: Record<string, SortDirection>;
-    readonly columns: SelectableColumn<T>[];
     readonly query: Query<T, R>;
     readonly meta: QueryMeta;
     readonly records: R[];
@@ -126,45 +117,46 @@ export declare class Query<T extends XataRecord, R extends XataRecord = T> imple
     filter(constraints: FilterConstraints<T>): Query<T, R>;
     filter<F extends keyof T>(column: F, value: FilterConstraints<T[F]> | DeepConstraint<T[F]>): Query<T, R>;
     sort<F extends keyof T>(column: F, direction: SortDirection): Query<T, R>;
-    getPaginated<Options extends BulkQueryOptions<T>>(options?: Options): Promise<Page<T, typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R>>;
+    getPaginated(options?: BulkQueryOptions<T>): Promise<Page<T, R>>;
     [Symbol.asyncIterator](): AsyncIterableIterator<R>;
     getIterator(chunk: number, options?: Omit<BulkQueryOptions<T>, 'page'>): AsyncGenerator<R[]>;
-    getMany<Options extends BulkQueryOptions<T>>(options?: Options): Promise<(typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R)[]>;
-    getOne<Options extends Omit<BulkQueryOptions<T>, 'page'>>(options?: Options): Promise<(typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R) | null>;
+    getMany(options?: BulkQueryOptions<T>): Promise<R[]>;
+    getOne(options?: Omit<BulkQueryOptions<T>, 'page'>): Promise<R | null>;
     deleteAll(): Promise<number>;
+    include(columns: Include<T>): this;
     nextPage(size?: number, offset?: number): Promise<Page<T, R>>;
     previousPage(size?: number, offset?: number): Promise<Page<T, R>>;
     firstPage(size?: number, offset?: number): Promise<Page<T, R>>;
     lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
     hasNextPage(): boolean;
 }
-export declare abstract class Repository<T extends XataRecord> extends Query<T> {
-    select<K extends SelectableColumn<T>>(columns: K[]): Query<T, Select<T, K>>;
+export declare abstract class Repository<T> extends Query<T, Selectable<T>> {
+    select<K extends keyof Selectable<T>>(...columns: K[]): Query<T, Select<T, K>>;
     abstract create(object: Selectable<T>): Promise<T>;
     abstract createMany(objects: Selectable<T>[]): Promise<T[]>;
     abstract read(id: string): Promise<T | null>;
     abstract update(id: string, object: Partial<T>): Promise<T>;
     abstract delete(id: string): void;
-    abstract _runQuery<R extends XataRecord, Options extends BulkQueryOptions<T>>(query: Query<T, R>, options: Options): Promise<Page<T, typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R>>;
+    abstract _runQuery<R>(query: Query<T, R>, options?: BulkQueryOptions<T>): Promise<Page<T, R>>;
 }
-export declare class RestRepository<T extends XataRecord> extends Repository<T> {
+export declare class RestRepository<T> extends Repository<T> {
     client: BaseClient<any>;
     fetch: any;
     constructor(client: BaseClient<any>, table: string);
     request<T>(method: string, path: string, body?: unknown): Promise<T | undefined>;
-    select<K extends SelectableColumn<T>>(columns: K[]): Query<T, Select<T, K>>;
+    select<K extends keyof T>(...columns: K[]): Query<T, Select<T, K>>;
     create(object: T): Promise<T>;
     createMany(objects: T[]): Promise<T[]>;
     read(id: string): Promise<T | null>;
     update(id: string, object: Partial<T>): Promise<T>;
     delete(id: string): Promise<void>;
-    _runQuery<R extends XataRecord, Options extends BulkQueryOptions<T>>(query: Query<T, R>, options: Options): Promise<Page<T, typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R>>;
+    _runQuery<R>(query: Query<T, R>, options?: BulkQueryOptions<T>): Promise<Page<T, R>>;
 }
 interface RepositoryFactory {
-    createRepository<T extends XataRecord>(client: BaseClient<any>, table: string): Repository<T>;
+    createRepository<T>(client: BaseClient<any>, table: string): Repository<T>;
 }
 export declare class RestRespositoryFactory implements RepositoryFactory {
-    createRepository<T extends XataRecord>(client: BaseClient<any>, table: string): Repository<T>;
+    createRepository<T>(client: BaseClient<any>, table: string): Repository<T>;
 }
 declare type BranchStrategyValue = string | undefined | null;
 declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;

package/dist/index.js

@@ -100,7 +100,6 @@ class Page {
 }
 class Query {
     constructor(repository, table, data, parent) {
-        this.columns = ['*'];
         // Cursor pagination
         this.query = this;
         this.meta = { page: { cursor: 'start', more: true } };
@@ -177,7 +176,7 @@ class Query {
         }, this);
         return q;
     }
-    getPaginated(options = {}) {
+    getPaginated(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.repository._runQuery(this, options);
         });
@@ -212,7 +211,7 @@ class Query {
             }
         });
     }
-    getMany(options = {}) {
+    getMany(options) {
         return __awaiter(this, void 0, void 0, function* () {
             const { records } = yield this.getPaginated(options);
             return records;
@@ -230,6 +229,10 @@ class Query {
             return 0;
         });
     }
+    include(columns) {
+        // TODO
+        return this;
+    }
     nextPage(size, offset) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.firstPage(size, offset);
@@ -256,8 +259,8 @@ class Query {
 }
 exports.Query = Query;
 class Repository extends Query {
-    select(columns) {
-        return new Query(this.repository, this.table, { columns });
+    select(...columns) {
+        return new Query(this.repository, this.table, {});
     }
 }
 exports.Repository = Repository;
@@ -314,8 +317,8 @@ class RestRepository extends Repository {
             return resp.json();
         });
     }
-    select(columns) {
-        return new Query(this.repository, this.table, { columns });
+    select(...columns) {
+        return new Query(this.repository, this.table, {});
     }
     create(object) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -377,7 +380,6 @@ class RestRepository extends Repository {
         });
     }
     _runQuery(query, options) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const filter = {
                 $any: query.$any,
@@ -387,9 +389,8 @@ class RestRepository extends Repository {
             };
             const body = {
                 filter: Object.values(filter).some(Boolean) ? filter : undefined,
-                sort: (_a = buildSortFilter(options === null || options === void 0 ? void 0 : options.sort)) !== null && _a !== void 0 ? _a : query.$sort,
-                page: options === null || options === void 0 ? void 0 : options.page,
-                columns: (_b = options === null || options === void 0 ? void 0 : options.columns) !== null && _b !== void 0 ? _b : query.columns
+                sort: query.$sort,
+                page: options === null || options === void 0 ? void 0 : options.page
             };
             const response = yield this.request('POST', `/tables/${this.table}/query`, body);
             if (!response) {
@@ -397,7 +398,6 @@ class RestRepository extends Repository {
             }
             const { meta, records: objects } = response;
             const records = objects.map((record) => this.client.initObject(this.table, record));
-            // TODO: We should properly type this any
             return new Page(query, meta, records);
         });
     }
@@ -507,22 +507,3 @@ const transformObjectLinks = (object) => {
         return Object.assign(Object.assign({}, acc), { [key]: value });
     }, {});
 };
-function buildSortFilter(filter) {
-    if (!filter)
-        return undefined;
-    const filters = Array.isArray(filter) ? filter : [filter];
-    return filters.reduce((acc, item) => {
-        if (typeof item === 'string') {
-            return Object.assign(Object.assign({}, acc), { [item]: 'asc' });
-        }
-        else if (isObjectSortFilter(item)) {
-            return Object.assign(Object.assign({}, acc), { [item.column]: item.direction });
-        }
-        else {
-            return acc;
-        }
-    }, {});
-}
-function isObjectSortFilter(filter) {
-    return typeof filter === 'object' && filter.column !== undefined;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xata.io/client",
-  "version": "0.0.0-alpha.ed1ba7e",
+  "version": "0.0.0-beta.18f8d57",
   "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": "ed1ba7edce38949e3e2cd9823523d6598126fe04"
+  "gitHead": "18f8d57ed1b43ef057251dae3fcf98a4d591f2cf"
 }