@xata.io/client 0.0.0-beta.d2072d7 → 0.0.0-beta.f2b2fa6

package/dist/index.d.ts

@@ -1,178 +1,56 @@
+import { FetchImpl } from './api/fetcher';
+import { Page } from './schema/pagination';
+import { Query, QueryOptions } from './schema/query';
+import { Selectable, SelectableColumn, Select } from './schema/selection';
 export interface XataRecord {
     id: string;
     xata: {
         version: number;
     };
     read(): Promise<this>;
-    update(data: Selectable<this>): Promise<this>;
+    update(data: Partial<Selectable<this>>): Promise<this>;
     delete(): Promise<void>;
 }
-export declare type Queries<T> = {
-    [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<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];
-};
-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 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 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;
-};
-declare type DeepConstraint<T> = T extends Record<string, any> ? {
-    [key in keyof T]?: T[key] | DeepConstraint<T[key]>;
-} : Constraint<T>;
-declare type ComparableType = number | Date;
-export declare const gt: <T extends ComparableType>(value: T) => Constraint<T>;
-export declare const ge: <T extends ComparableType>(value: T) => Constraint<T>;
-export declare const gte: <T extends ComparableType>(value: T) => Constraint<T>;
-export declare const lt: <T extends ComparableType>(value: T) => Constraint<T>;
-export declare const lte: <T extends ComparableType>(value: T) => Constraint<T>;
-export declare const le: <T extends ComparableType>(value: T) => Constraint<T>;
-export declare const exists: (column: string) => Constraint<string>;
-export declare const notExists: (column: string) => Constraint<string>;
-export declare const startsWith: (value: string) => Constraint<string>;
-export declare const endsWith: (value: string) => Constraint<string>;
-export declare const pattern: (value: string) => Constraint<string>;
-export declare const is: <T>(value: T) => Constraint<T>;
-export declare const isNot: <T>(value: T) => Constraint<T>;
-export declare const contains: <T>(value: T) => Constraint<T>;
-export declare const includes: (value: string) => Constraint<string>;
-export declare const includesSubstring: (value: string) => Constraint<string>;
-export declare const includesPattern: (value: string) => Constraint<string>;
-export declare const includesAll: (value: string) => Constraint<string>;
-declare type FilterConstraints<T> = {
-    [key in keyof T]?: T[key] extends Record<string, any> ? FilterConstraints<T[key]> : T[key] | DeepConstraint<T[key]>;
-};
-declare type CursorNavigationOptions = {
-    first?: string;
-} | {
-    last?: string;
-} | {
-    after?: string;
-    before?: string;
-};
-declare type OffsetNavigationOptions = {
-    size?: number;
-    offset?: number;
-};
-declare type PaginationOptions = CursorNavigationOptions & OffsetNavigationOptions;
-declare type BulkQueryOptions<T> = {
-    page?: PaginationOptions;
-};
-declare type QueryOrConstraint<T, R> = Query<T, R> | Constraint<T>;
-declare type QueryMeta = {
-    page: {
-        cursor: string;
-        more: boolean;
-    };
-};
-interface BasePage<T, R> {
-    query: Query<T, R>;
-    meta: QueryMeta;
-    records: R[];
-    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;
-}
-declare class Page<T, R> implements BasePage<T, R> {
-    readonly query: Query<T, R>;
-    readonly meta: QueryMeta;
-    readonly records: R[];
-    constructor(query: Query<T, R>, meta: QueryMeta, records?: R[]);
-    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 class Query<T, R = T> implements BasePage<T, R> {
-    table: string;
-    repository: Repository<T>;
-    readonly $any?: QueryOrConstraint<T, R>[];
-    readonly $all?: QueryOrConstraint<T, R>[];
-    readonly $not?: QueryOrConstraint<T, R>[];
-    readonly $none?: QueryOrConstraint<T, R>[];
-    readonly $sort?: Record<string, SortDirection>;
-    readonly query: Query<T, R>;
-    readonly meta: QueryMeta;
-    readonly records: R[];
-    constructor(repository: Repository<T> | null, table: string, data: Partial<Query<T, R>>, parent?: Query<T, R>);
-    any(...queries: Query<T, R>[]): Query<T, R>;
-    all(...queries: Query<T, R>[]): Query<T, R>;
-    not(...queries: Query<T, R>[]): Query<T, R>;
-    none(...queries: Query<T, R>[]): Query<T, R>;
-    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?: BulkQueryOptions<T>): Promise<Page<T, R>>;
-    [Symbol.asyncIterator](): AsyncIterableIterator<R>;
-    getIterator(chunk: number, options?: Omit<BulkQueryOptions<T>, 'page'>): AsyncGenerator<R[]>;
-    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 Query<T, Selectable<T>> {
-    select<K extends keyof Selectable<T>>(...columns: K[]): Query<T, Select<T, K>>;
+export declare abstract class Repository<T extends XataRecord> extends Query<T> {
     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 update(id: string, object: Partial<Selectable<T>>): Promise<T>;
+    abstract upsert(id: string, object: Selectable<T>): Promise<T>;
     abstract delete(id: string): void;
-    abstract _runQuery<R>(query: Query<T, R>, options?: BulkQueryOptions<T>): Promise<Page<T, R>>;
+    abstract query<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options: Options): Promise<Page<T, typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R>>;
 }
-export declare class RestRepository<T> extends Repository<T> {
-    client: BaseClient<any>;
-    fetch: any;
+export declare class RestRepository<T extends XataRecord> extends Repository<T> {
+    #private;
     constructor(client: BaseClient<any>, table: string);
-    request<T>(method: string, path: string, body?: unknown): Promise<T | undefined>;
-    select<K extends keyof T>(...columns: K[]): Query<T, Select<T, K>>;
-    create(object: T): Promise<T>;
+    create(object: Selectable<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>(query: Query<T, R>, options?: BulkQueryOptions<T>): Promise<Page<T, R>>;
+    read(recordId: string): Promise<T | null>;
+    update(recordId: string, object: Partial<Selectable<T>>): Promise<T>;
+    upsert(recordId: string, object: Selectable<T>): Promise<T>;
+    delete(recordId: string): Promise<void>;
+    query<R extends XataRecord, Options extends QueryOptions<T>>(query: Query<T, R>, options: Options): Promise<Page<T, typeof options['columns'] extends SelectableColumn<T>[] ? Select<T, typeof options['columns'][number]> : R>>;
 }
 interface RepositoryFactory {
-    createRepository<T>(client: BaseClient<any>, table: string): Repository<T>;
+    createRepository<T extends XataRecord>(client: BaseClient<any>, table: string): Repository<T>;
 }
 export declare class RestRespositoryFactory implements RepositoryFactory {
-    createRepository<T>(client: BaseClient<any>, table: string): Repository<T>;
+    createRepository<T extends XataRecord>(client: BaseClient<any>, table: string): Repository<T>;
 }
 declare type BranchStrategyValue = string | undefined | null;
 declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
 declare type BranchStrategy = BranchStrategyValue | BranchStrategyBuilder;
 declare type BranchStrategyOption = NonNullable<BranchStrategy | BranchStrategy[]>;
 export declare type XataClientOptions = {
-    fetch?: unknown;
-    databaseURL: string;
+    fetch?: FetchImpl;
+    databaseURL?: string;
     branch: BranchStrategyOption;
     apiKey: string;
     repositoryFactory?: RepositoryFactory;
 };
 export declare class BaseClient<D extends Record<string, Repository<any>>> {
+    #private;
     options: XataClientOptions;
-    private links;
-    private branch;
     db: D;
     constructor(options: XataClientOptions, links: Links);
     initObject<T>(table: string, object: object): T;
@@ -183,4 +61,5 @@ export declare class XataError extends Error {
     constructor(message: string, status: number);
 }
 export declare type Links = Record<string, Array<string[]>>;
-export {};
+export * from './api';
+export * from './schema';