@xata.io/client 0.0.0-beta.d76c443 → 0.0.0-beta.dbbad41

package/dist/schema/repository.d.ts

@@ -1,9 +1,11 @@
 import { FetchImpl } from '../api/fetcher';
+import { Dictionary, GetArrayInnerType, StringKeys } from '../util/types';
 import { Page } from './pagination';
 import { Query } from './query';
 import { BaseData, EditableData, Identifiable, XataRecord } from './record';
 import { SelectedPick } from './selection';
-export declare type Links = Record<string, Array<string[]>>;
+declare type TableLink = string[];
+export declare type LinkDictionary = Dictionary<TableLink[]>;
 /**
  * Common interface for performing operations on a table.
  */
@@ -93,11 +95,20 @@ export declare abstract class Repository<Data extends BaseData, Record extends X
      * @throws If the record could not be found or there was an error while performing the deletion.
      */
     abstract delete(ids: Identifiable[]): Promise<void>;
+    /**
+     * Search for records in the table.
+     * @param query The query to search for.
+     * @param options The options to search with (like: fuzziness)
+     * @returns The found records.
+     */
+    abstract search(query: string, options?: {
+        fuzziness?: number;
+    }): Promise<SelectedPick<Record, ['*']>[]>;
     abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
 }
 export declare class RestRepository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> {
     #private;
-    constructor(client: BaseClient<any>, table: string);
+    constructor(client: BaseClient<any>, table: string, links?: LinkDictionary);
     create(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
     create(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
     create(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
@@ -109,13 +120,16 @@ export declare class RestRepository<Data extends BaseData, Record extends XataRe
     createOrUpdate(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
     createOrUpdate(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
     delete(recordId: string | Identifiable | Array<string | Identifiable>): Promise<void>;
+    search(query: string, options?: {
+        fuzziness?: number;
+    }): Promise<SelectedPick<Record, ['*']>[]>;
     query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
 }
 interface RepositoryFactory {
-    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string): Repository<Data & XataRecord>;
+    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string, links?: LinkDictionary): Repository<Data & XataRecord>;
 }
 export declare class RestRespositoryFactory implements RepositoryFactory {
-    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string): Repository<Data & XataRecord>;
+    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string, links?: LinkDictionary): Repository<Data & XataRecord>;
 }
 declare type BranchStrategyValue = string | undefined | null;
 declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
@@ -138,11 +152,14 @@ export declare type XataClientOptions = {
     repositoryFactory?: RepositoryFactory;
 };
 export declare class BaseClient<D extends Record<string, Repository<any>> = Record<string, Repository<any>>> {
-    #private;
     options: XataClientOptions;
     db: D;
-    constructor(options?: XataClientOptions, links?: Links);
-    initObject<T>(table: string, object: object): T;
-    getBranch(): Promise<string>;
+    constructor(options?: XataClientOptions, links?: LinkDictionary);
+    search<Tables extends StringKeys<D>>(query: string, options?: {
+        fuzziness?: number;
+        tables?: Tables[];
+    }): Promise<{
+        [Model in GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>]: Awaited<ReturnType<D[Model]['search']>>;
+    }>;
 }
 export {};

package/dist/schema/repository.js

@@ -26,7 +26,7 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
     function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
     function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
 };
-var _RestRepository_instances, _RestRepository_client, _RestRepository_fetch, _RestRepository_table, _RestRepository_getFetchProps, _RestRepository_insertRecordWithoutId, _RestRepository_insertRecordWithId, _RestRepository_bulkInsertTableRecords, _RestRepository_updateRecordWithID, _RestRepository_upsertRecordWithID, _RestRepository_deleteRecord, _BaseClient_links, _BaseClient_branch;
+var _RestRepository_instances, _RestRepository_client, _RestRepository_fetch, _RestRepository_table, _RestRepository_links, _RestRepository_branch, _RestRepository_getFetchProps, _RestRepository_getBranch, _RestRepository_insertRecordWithoutId, _RestRepository_insertRecordWithId, _RestRepository_bulkInsertTableRecords, _RestRepository_updateRecordWithID, _RestRepository_upsertRecordWithID, _RestRepository_deleteRecord, _RestRepository_initObject;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseClient = exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = void 0;
 const api_1 = require("../api");
@@ -44,15 +44,18 @@ class Repository extends query_1.Query {
 }
 exports.Repository = Repository;
 class RestRepository extends query_1.Query {
-    constructor(client, table) {
+    constructor(client, table, links) {
         super(null, table, {});
         _RestRepository_instances.add(this);
         _RestRepository_client.set(this, void 0);
         _RestRepository_fetch.set(this, void 0);
         _RestRepository_table.set(this, void 0);
+        _RestRepository_links.set(this, void 0);
+        _RestRepository_branch.set(this, void 0);
         __classPrivateFieldSet(this, _RestRepository_client, client, "f");
         __classPrivateFieldSet(this, _RestRepository_table, table, "f");
         __classPrivateFieldSet(this, _RestRepository_fetch, (0, fetch_1.getFetchImplementation)(__classPrivateFieldGet(this, _RestRepository_client, "f").options.fetch), "f");
+        __classPrivateFieldSet(this, _RestRepository_links, links !== null && links !== void 0 ? links : {}, "f");
     }
     create(a, b) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -85,7 +88,7 @@ class RestRepository extends query_1.Query {
             const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
             try {
                 const response = yield (0, api_1.getRecord)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f"), recordId } }, fetchProps));
-                return __classPrivateFieldGet(this, _RestRepository_client, "f").initObject(__classPrivateFieldGet(this, _RestRepository_table, "f"), response);
+                return __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_initObject).call(this, __classPrivateFieldGet(this, _RestRepository_table, "f"), response);
             }
             catch (e) {
                 if ((0, lang_1.isObject)(e) && e.status === 404) {
@@ -161,6 +164,13 @@ class RestRepository extends query_1.Query {
             throw new Error('Invalid arguments for delete method');
         });
     }
+    search(query, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
+            const { records } = yield (0, api_1.searchBranch)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}' }, body: { tables: [__classPrivateFieldGet(this, _RestRepository_table, "f")], query, fuzziness: options.fuzziness } }, fetchProps));
+            return records.map((item) => __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_initObject).call(this, __classPrivateFieldGet(this, _RestRepository_table, "f"), item));
+        });
+    }
     query(query) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -173,16 +183,16 @@ class RestRepository extends query_1.Query {
             };
             const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
             const { meta, records: objects } = yield (0, api_1.queryTable)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f") }, body }, fetchProps));
-            const records = objects.map((record) => __classPrivateFieldGet(this, _RestRepository_client, "f").initObject(__classPrivateFieldGet(this, _RestRepository_table, "f"), record));
+            const records = objects.map((record) => __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_initObject).call(this, __classPrivateFieldGet(this, _RestRepository_table, "f"), record));
             return new pagination_1.Page(query, meta, records);
         });
     }
 }
 exports.RestRepository = RestRepository;
-_RestRepository_client = new WeakMap(), _RestRepository_fetch = new WeakMap(), _RestRepository_table = new WeakMap(), _RestRepository_instances = new WeakSet(), _RestRepository_getFetchProps = function _RestRepository_getFetchProps() {
+_RestRepository_client = new WeakMap(), _RestRepository_fetch = new WeakMap(), _RestRepository_table = new WeakMap(), _RestRepository_links = new WeakMap(), _RestRepository_branch = new WeakMap(), _RestRepository_instances = new WeakSet(), _RestRepository_getFetchProps = function _RestRepository_getFetchProps() {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
-        const branch = yield __classPrivateFieldGet(this, _RestRepository_client, "f").getBranch();
+        const branch = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getBranch).call(this);
         const apiKey = (_a = __classPrivateFieldGet(this, _RestRepository_client, "f").options.apiKey) !== null && _a !== void 0 ? _a : (0, config_1.getAPIKey)();
         if (!apiKey) {
             throw new Error('Could not resolve a valid apiKey');
@@ -201,6 +211,35 @@ _RestRepository_client = new WeakMap(), _RestRepository_fetch = new WeakMap(), _
             }
         };
     });
+}, _RestRepository_getBranch = function _RestRepository_getBranch() {
+    var e_1, _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        if (__classPrivateFieldGet(this, _RestRepository_branch, "f"))
+            return __classPrivateFieldGet(this, _RestRepository_branch, "f");
+        const { branch: param } = __classPrivateFieldGet(this, _RestRepository_client, "f").options;
+        const strategies = Array.isArray(param) ? [...param] : [param];
+        const evaluateBranch = (strategy) => __awaiter(this, void 0, void 0, function* () {
+            return isBranchStrategyBuilder(strategy) ? yield strategy() : strategy;
+        });
+        try {
+            for (var strategies_1 = __asyncValues(strategies), strategies_1_1; strategies_1_1 = yield strategies_1.next(), !strategies_1_1.done;) {
+                const strategy = strategies_1_1.value;
+                const branch = yield evaluateBranch(strategy);
+                if (branch) {
+                    __classPrivateFieldSet(this, _RestRepository_branch, branch, "f");
+                    return branch;
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (strategies_1_1 && !strategies_1_1.done && (_a = strategies_1.return)) yield _a.call(strategies_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        throw new Error('Unable to resolve branch value');
+    });
 }, _RestRepository_insertRecordWithoutId = function _RestRepository_insertRecordWithoutId(object) {
     return __awaiter(this, void 0, void 0, function* () {
         const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
@@ -267,10 +306,36 @@ _RestRepository_client = new WeakMap(), _RestRepository_fetch = new WeakMap(), _
         const fetchProps = yield __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_getFetchProps).call(this);
         yield (0, api_1.deleteRecord)(Object.assign({ pathParams: { workspace: '{workspaceId}', dbBranchName: '{dbBranch}', tableName: __classPrivateFieldGet(this, _RestRepository_table, "f"), recordId } }, fetchProps));
     });
+}, _RestRepository_initObject = function _RestRepository_initObject(table, object) {
+    const result = {};
+    Object.assign(result, object);
+    const tableLinks = __classPrivateFieldGet(this, _RestRepository_links, "f")[table] || [];
+    for (const link of tableLinks) {
+        const [field, linkTable] = link;
+        const value = result[field];
+        if (value && (0, lang_1.isObject)(value)) {
+            result[field] = __classPrivateFieldGet(this, _RestRepository_instances, "m", _RestRepository_initObject).call(this, linkTable, value);
+        }
+    }
+    const db = __classPrivateFieldGet(this, _RestRepository_client, "f").db;
+    result.read = function () {
+        return db[table].read(result['id']);
+    };
+    result.update = function (data) {
+        return db[table].update(result['id'], data);
+    };
+    result.delete = function () {
+        return db[table].delete(result['id']);
+    };
+    for (const prop of ['read', 'update', 'delete']) {
+        Object.defineProperty(result, prop, { enumerable: false });
+    }
+    Object.freeze(result);
+    return result;
 };
 class RestRespositoryFactory {
-    createRepository(client, table) {
-        return new RestRepository(client, table);
+    createRepository(client, table, links) {
+        return new RestRepository(client, table, links);
     }
 }
 exports.RestRespositoryFactory = RestRespositoryFactory;
@@ -286,82 +351,30 @@ function resolveXataClientOptions(options) {
         branch });
 }
 class BaseClient {
-    constructor(options = {}, links = {}) {
-        _BaseClient_links.set(this, void 0);
-        _BaseClient_branch.set(this, void 0);
+    constructor(options = {}, links) {
         this.options = resolveXataClientOptions(options);
         // Make this property not enumerable so it doesn't show up in console.dir, etc.
         Object.defineProperty(this.options, 'apiKey', { enumerable: false });
-        __classPrivateFieldSet(this, _BaseClient_links, links, "f");
         const factory = this.options.repositoryFactory || new RestRespositoryFactory();
         this.db = new Proxy({}, {
             get: (_target, prop) => {
-                if (typeof prop !== 'string')
+                if (!(0, lang_1.isString)(prop))
                     throw new Error('Invalid table name');
-                return factory.createRepository(this, prop);
+                return factory.createRepository(this, prop, links);
             }
         });
     }
-    initObject(table, object) {
-        const result = {};
-        Object.assign(result, object);
-        const tableLinks = __classPrivateFieldGet(this, _BaseClient_links, "f")[table] || [];
-        for (const link of tableLinks) {
-            const [field, linkTable] = link;
-            const value = result[field];
-            if (value && (0, lang_1.isObject)(value)) {
-                result[field] = this.initObject(linkTable, value);
-            }
-        }
-        const db = this.db;
-        result.read = function () {
-            return db[table].read(result['id']);
-        };
-        result.update = function (data) {
-            return db[table].update(result['id'], data);
-        };
-        result.delete = function () {
-            return db[table].delete(result['id']);
-        };
-        for (const prop of ['read', 'update', 'delete']) {
-            Object.defineProperty(result, prop, { enumerable: false });
-        }
-        Object.freeze(result);
-        return result;
-    }
-    getBranch() {
-        var e_1, _a;
+    search(query, options) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            if (__classPrivateFieldGet(this, _BaseClient_branch, "f"))
-                return __classPrivateFieldGet(this, _BaseClient_branch, "f");
-            const { branch: param } = this.options;
-            const strategies = Array.isArray(param) ? [...param] : [param];
-            const evaluateBranch = (strategy) => __awaiter(this, void 0, void 0, function* () {
-                return isBranchStrategyBuilder(strategy) ? yield strategy() : strategy;
-            });
-            try {
-                for (var strategies_1 = __asyncValues(strategies), strategies_1_1; strategies_1_1 = yield strategies_1.next(), !strategies_1_1.done;) {
-                    const strategy = strategies_1_1.value;
-                    const branch = yield evaluateBranch(strategy);
-                    if (branch) {
-                        __classPrivateFieldSet(this, _BaseClient_branch, branch, "f");
-                        return branch;
-                    }
-                }
-            }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
-            finally {
-                try {
-                    if (strategies_1_1 && !strategies_1_1.done && (_a = strategies_1.return)) yield _a.call(strategies_1);
-                }
-                finally { if (e_1) throw e_1.error; }
-            }
-            throw new Error('Unable to resolve branch value');
+            const tables = (_a = options === null || options === void 0 ? void 0 : options.tables) !== null && _a !== void 0 ? _a : Object.keys(this.db);
+            // TODO: Implement global search with a single call, REST repository abstraction needed
+            const results = yield Promise.all(tables.map((table) => this.db[table].search(query, options).then((results) => [table, results])));
+            return Object.fromEntries(results);
         });
     }
 }
 exports.BaseClient = BaseClient;
-_BaseClient_links = new WeakMap(), _BaseClient_branch = new WeakMap();
 const isBranchStrategyBuilder = (strategy) => {
     return typeof strategy === 'function';
 };

package/dist/util/types.d.ts

@@ -21,4 +21,5 @@ declare type Impossible<K extends keyof any> = {
 };
 export declare type Exactly<T, U extends T = T> = U & Impossible<Exclude<keyof U, keyof T>>;
 export declare type SingleOrArray<T> = T | T[];
+export declare type Dictionary<T> = Record<string, T>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xata.io/client",
-  "version": "0.0.0-beta.d76c443",
+  "version": "0.0.0-beta.dbbad41",
   "description": "Xata.io SDK for TypeScript and JavaScript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -23,5 +23,5 @@
     "url": "https://github.com/xataio/client-ts/issues"
   },
   "homepage": "https://github.com/xataio/client-ts/blob/main/client/README.md",
-  "gitHead": "d76c443e4769df5339ab46ecd2714a8613dd9084"
+  "gitHead": "dbbad41f2eba57aac5fcb90380bb3355a0126925"
 }