@xata.io/client 0.7.1 → 0.8.1

package/.eslintrc.cjs

@@ -3,7 +3,7 @@ module.exports = {
   parserOptions: {
     ecmaVersion: 2020,
     sourceType: 'module',
-    project: 'client/tsconfig.json'
+    project: 'packages/client/tsconfig.json'
   },
   rules: {
     '@typescript-eslint/no-explicit-any': 'off',

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @xata.io/client
 
+## 0.8.1
+
+### Patch Changes
+
+- 5110261: Fix execution from the browser
+- aa3d7e7: Allow sending sort as in the API
+- 0047193: Add new plugin system for the SDK
+- 43856a5: Add discriminated union search
+
+## 0.8.0
+
+### Patch Changes
+
+- bde908e: Refactor client builder
+- ea3eef8: Make records returned by the API readonly
+
+## 0.7.2
+
+### Patch Changes
+
+- 4803b6f: Memoize ApiClient namespaces
+- 1f268d7: Add search in XataClient
+- d58c3d9: Hide private helper utilities
+- f3b731b: Expose branch resolution API
+
 ## 0.7.1
 
 ### Patch Changes

package/dist/api/client.js

@@ -10,10 +10,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _XataApiClient_extraProps;
+var _XataApiClient_extraProps, _XataApiClient_namespaces;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.XataApiClient = void 0;
-const config_1 = require("../schema/config");
+const config_1 = require("../util/config");
 const fetch_1 = require("../util/fetch");
 const components_1 = require("./components");
 const providers_1 = require("./providers");
@@ -21,6 +21,7 @@ class XataApiClient {
     constructor(options) {
         var _a, _b;
         _XataApiClient_extraProps.set(this, void 0);
+        _XataApiClient_namespaces.set(this, {});
         const provider = (_a = options.host) !== null && _a !== void 0 ? _a : 'production';
         const apiKey = (_b = options === null || options === void 0 ? void 0 : options.apiKey) !== null && _b !== void 0 ? _b : (0, config_1.getAPIKey)();
         if (!apiKey) {
@@ -34,26 +35,38 @@ class XataApiClient {
         }, "f");
     }
     get user() {
-        return new UserApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        if (!__classPrivateFieldGet(this, _XataApiClient_namespaces, "f").user)
+            __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").user = new UserApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        return __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").user;
     }
     get workspaces() {
-        return new WorkspaceApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        if (!__classPrivateFieldGet(this, _XataApiClient_namespaces, "f").workspaces)
+            __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").workspaces = new WorkspaceApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        return __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").workspaces;
     }
     get databases() {
-        return new DatabaseApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        if (!__classPrivateFieldGet(this, _XataApiClient_namespaces, "f").databases)
+            __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").databases = new DatabaseApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        return __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").databases;
     }
     get branches() {
-        return new BranchApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        if (!__classPrivateFieldGet(this, _XataApiClient_namespaces, "f").branches)
+            __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").branches = new BranchApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        return __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").branches;
     }
     get tables() {
-        return new TableApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        if (!__classPrivateFieldGet(this, _XataApiClient_namespaces, "f").tables)
+            __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").tables = new TableApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        return __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").tables;
     }
     get records() {
-        return new RecordsApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        if (!__classPrivateFieldGet(this, _XataApiClient_namespaces, "f").records)
+            __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").records = new RecordsApi(__classPrivateFieldGet(this, _XataApiClient_extraProps, "f"));
+        return __classPrivateFieldGet(this, _XataApiClient_namespaces, "f").records;
     }
 }
 exports.XataApiClient = XataApiClient;
-_XataApiClient_extraProps = new WeakMap();
+_XataApiClient_extraProps = new WeakMap(), _XataApiClient_namespaces = new WeakMap();
 class UserApi {
     constructor(extraProps) {
         this.extraProps = extraProps;

package/dist/api/index.d.ts

@@ -1,7 +1,13 @@
+import { XataPlugin, XataPluginOptions } from '../plugins';
+import { XataApiClient } from './client';
 import { operationsByTag } from './components';
 import type * as Responses from './responses';
 import type * as Schemas from './schemas';
 export * from './client';
 export * from './components';
+export type { FetcherExtraProps, FetchImpl } from './fetcher';
 export { operationsByTag as Operations };
 export type { Responses, Schemas };
+export declare class XataApiPlugin implements XataPlugin {
+    build(options: XataPluginOptions): Promise<XataApiClient>;
+}

package/dist/api/index.js

@@ -13,9 +13,28 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Operations = void 0;
+exports.XataApiPlugin = exports.Operations = void 0;
+const client_1 = require("./client");
 const components_1 = require("./components");
 Object.defineProperty(exports, "Operations", { enumerable: true, get: function () { return components_1.operationsByTag; } });
 __exportStar(require("./client"), exports);
 __exportStar(require("./components"), exports);
+class XataApiPlugin {
+    build(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { fetchImpl, apiKey } = yield options.getFetchProps();
+            return new client_1.XataApiClient({ fetch: fetchImpl, apiKey });
+        });
+    }
+}
+exports.XataApiPlugin = XataApiPlugin;

package/dist/client.d.ts

@@ -0,0 +1,27 @@
+import { FetchImpl } from './api/fetcher';
+import { XataPlugin } from './plugins';
+import { SchemaPlugin } from './schema';
+import { BaseData } from './schema/record';
+import { LinkDictionary } from './schema/repository';
+import { SearchPlugin } from './search';
+import { BranchStrategyOption } from './util/branches';
+import { StringKeys } from './util/types';
+export declare type BaseClientOptions = {
+    fetch?: FetchImpl;
+    apiKey?: string;
+    databaseURL?: string;
+    branch?: BranchStrategyOption;
+};
+export declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins | undefined) => ClientConstructor<Plugins>;
+export interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
+    new <Schemas extends Record<string, BaseData>>(options?: Partial<BaseClientOptions>, links?: LinkDictionary): Omit<{
+        db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
+        search: Awaited<ReturnType<SearchPlugin<Schemas>['build']>>;
+    }, keyof Plugins> & {
+        [Key in StringKeys<NonNullable<Plugins>>]: Awaited<ReturnType<NonNullable<Plugins>[Key]['build']>>;
+    };
+}
+declare const BaseClient_base: ClientConstructor<{}>;
+export declare class BaseClient extends BaseClient_base<Record<string, any>> {
+}
+export {};

package/dist/client.js

@@ -0,0 +1,131 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    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); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseClient = exports.buildClient = void 0;
+const schema_1 = require("./schema");
+const search_1 = require("./search");
+const branches_1 = require("./util/branches");
+const config_1 = require("./util/config");
+const fetch_1 = require("./util/fetch");
+const buildClient = (plugins) => {
+    var _instances, _branch, _parseOptions, _getFetchProps, _evaluateBranch, _a;
+    return _a = class {
+            constructor(options = {}, links) {
+                _instances.add(this);
+                _branch.set(this, void 0);
+                const safeOptions = __classPrivateFieldGet(this, _instances, "m", _parseOptions).call(this, options);
+                const namespaces = Object.assign({ db: new schema_1.SchemaPlugin(links), search: new search_1.SearchPlugin() }, plugins);
+                for (const [key, namespace] of Object.entries(namespaces)) {
+                    if (!namespace)
+                        continue;
+                    const result = namespace.build({ getFetchProps: () => __classPrivateFieldGet(this, _instances, "m", _getFetchProps).call(this, safeOptions) });
+                    if (result instanceof Promise) {
+                        void result.then((namespace) => {
+                            // @ts-ignore
+                            this[key] = namespace;
+                        });
+                    }
+                    else {
+                        // @ts-ignore
+                        this[key] = result;
+                    }
+                }
+            }
+        },
+        _branch = new WeakMap(),
+        _instances = new WeakSet(),
+        _parseOptions = function _parseOptions(options) {
+            const fetch = (0, fetch_1.getFetchImplementation)(options === null || options === void 0 ? void 0 : options.fetch);
+            const databaseURL = (options === null || options === void 0 ? void 0 : options.databaseURL) || (0, config_1.getDatabaseURL)();
+            const apiKey = (options === null || options === void 0 ? void 0 : options.apiKey) || (0, config_1.getAPIKey)();
+            const branch = () => __awaiter(this, void 0, void 0, function* () {
+                return (options === null || options === void 0 ? void 0 : options.branch)
+                    ? yield __classPrivateFieldGet(this, _instances, "m", _evaluateBranch).call(this, options.branch)
+                    : yield (0, config_1.getCurrentBranchName)({ apiKey, databaseURL, fetchImpl: options === null || options === void 0 ? void 0 : options.fetch });
+            });
+            if (!databaseURL || !apiKey) {
+                throw new Error('Options databaseURL and apiKey are required');
+            }
+            return { fetch, databaseURL, apiKey, branch };
+        },
+        _getFetchProps = function _getFetchProps({ fetch, apiKey, databaseURL, branch }) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const branchValue = yield __classPrivateFieldGet(this, _instances, "m", _evaluateBranch).call(this, branch);
+                if (!branchValue)
+                    throw new Error('Unable to resolve branch value');
+                return {
+                    fetchImpl: fetch,
+                    apiKey,
+                    apiUrl: '',
+                    // Instead of using workspace and dbBranch, we inject a probably CNAME'd URL
+                    workspacesApiUrl: (path, params) => {
+                        var _a;
+                        const hasBranch = (_a = params.dbBranchName) !== null && _a !== void 0 ? _a : params.branch;
+                        const newPath = path.replace(/^\/db\/[^/]+/, hasBranch ? `:${branchValue}` : '');
+                        return databaseURL + newPath;
+                    }
+                };
+            });
+        },
+        _evaluateBranch = function _evaluateBranch(param) {
+            var e_1, _a;
+            return __awaiter(this, void 0, void 0, function* () {
+                if (__classPrivateFieldGet(this, _branch, "f"))
+                    return __classPrivateFieldGet(this, _branch, "f");
+                if (!param)
+                    return undefined;
+                const strategies = Array.isArray(param) ? [...param] : [param];
+                const evaluateBranch = (strategy) => __awaiter(this, void 0, void 0, function* () {
+                    return (0, branches_1.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, _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; }
+                }
+            });
+        },
+        _a;
+};
+exports.buildClient = buildClient;
+class BaseClient extends (0, exports.buildClient)() {
+}
+exports.BaseClient = BaseClient;

package/dist/index.d.ts

@@ -3,4 +3,8 @@ export declare class XataError extends Error {
     constructor(message: string, status: number);
 }
 export * from './api';
+export * from './plugins';
+export * from './client';
 export * from './schema';
+export * from './search';
+export * from './util/config';

package/dist/index.js

@@ -23,4 +23,8 @@ class XataError extends Error {
 }
 exports.XataError = XataError;
 __exportStar(require("./api"), exports);
+__exportStar(require("./plugins"), exports);
+__exportStar(require("./client"), exports);
 __exportStar(require("./schema"), exports);
+__exportStar(require("./search"), exports);
+__exportStar(require("./util/config"), exports);

package/dist/plugins.d.ts

@@ -0,0 +1,7 @@
+import { FetcherExtraProps } from './api/fetcher';
+export declare abstract class XataPlugin {
+    abstract build(options: XataPluginOptions): unknown | Promise<unknown>;
+}
+export declare type XataPluginOptions = {
+    getFetchProps: () => Promise<FetcherExtraProps>;
+};

package/dist/plugins.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XataPlugin = void 0;
+class XataPlugin {
+}
+exports.XataPlugin = XataPlugin;

package/dist/schema/filters.spec.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unused-vars */
+const vitest_1 = require("vitest");
 // Single column with implicit is
 const singleColumnWithImplicitIs = { name: 'r2' };
 // Single column with explicit is
@@ -170,6 +172,6 @@ const filterWithInvalidNestedObjectPropertyType = { settings: { plan: 42 } };
 // Filter with invalid property $is type
 // @ts-expect-error
 const filterWithInvalidOperator = { name: { $is: 42 } };
-test('fake test', () => {
+(0, vitest_1.test)('fake test', () => {
     // This is a fake test to make sure that the type definitions in this file are working
 });

package/dist/schema/index.d.ts

@@ -1,7 +1,23 @@
+import { XataPlugin, XataPluginOptions } from '../plugins';
+import { BaseData } from './record';
+import { LinkDictionary, Repository } from './repository';
 export * from './operators';
 export * from './pagination';
 export { Query } from './query';
 export { isIdentifiable, isXataRecord } from './record';
-export type { Identifiable, XataRecord } from './record';
-export { BaseClient, Repository, RestRepository, RestRespositoryFactory } from './repository';
-export type { XataClientOptions } from './repository';
+export type { BaseData, EditableData, Identifiable, XataRecord } from './record';
+export { Repository, RestRepository } from './repository';
+export type { LinkDictionary } from './repository';
+export * from './selection';
+export declare type SchemaDefinition = {
+    table: string;
+    links?: LinkDictionary;
+};
+export declare type SchemaPluginResult<Schemas extends Record<string, BaseData>> = {
+    [Key in keyof Schemas]: Repository<Schemas[Key]>;
+};
+export declare class SchemaPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
+    private links?;
+    constructor(links?: LinkDictionary | undefined);
+    build(options: XataPluginOptions): SchemaPluginResult<Schemas>;
+}

package/dist/schema/index.js

@@ -14,7 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = exports.BaseClient = exports.isXataRecord = exports.isIdentifiable = exports.Query = void 0;
+exports.SchemaPlugin = exports.RestRepository = exports.Repository = exports.isXataRecord = exports.isIdentifiable = exports.Query = void 0;
+const plugins_1 = require("../plugins");
+const lang_1 = require("../util/lang");
+const repository_1 = require("./repository");
 __exportStar(require("./operators"), exports);
 __exportStar(require("./pagination"), exports);
 var query_1 = require("./query");
@@ -22,8 +25,26 @@ Object.defineProperty(exports, "Query", { enumerable: true, get: function () { r
 var record_1 = require("./record");
 Object.defineProperty(exports, "isIdentifiable", { enumerable: true, get: function () { return record_1.isIdentifiable; } });
 Object.defineProperty(exports, "isXataRecord", { enumerable: true, get: function () { return record_1.isXataRecord; } });
-var repository_1 = require("./repository");
-Object.defineProperty(exports, "BaseClient", { enumerable: true, get: function () { return repository_1.BaseClient; } });
-Object.defineProperty(exports, "Repository", { enumerable: true, get: function () { return repository_1.Repository; } });
-Object.defineProperty(exports, "RestRepository", { enumerable: true, get: function () { return repository_1.RestRepository; } });
-Object.defineProperty(exports, "RestRespositoryFactory", { enumerable: true, get: function () { return repository_1.RestRespositoryFactory; } });
+var repository_2 = require("./repository");
+Object.defineProperty(exports, "Repository", { enumerable: true, get: function () { return repository_2.Repository; } });
+Object.defineProperty(exports, "RestRepository", { enumerable: true, get: function () { return repository_2.RestRepository; } });
+__exportStar(require("./selection"), exports);
+class SchemaPlugin extends plugins_1.XataPlugin {
+    constructor(links) {
+        super();
+        this.links = links;
+    }
+    build(options) {
+        const { getFetchProps } = options;
+        const links = this.links;
+        const db = new Proxy({}, {
+            get: (_target, table) => {
+                if (!(0, lang_1.isString)(table))
+                    throw new Error('Invalid table name');
+                return new repository_1.RestRepository({ db, getFetchProps, table, links });
+            }
+        });
+        return db;
+    }
+}
+exports.SchemaPlugin = SchemaPlugin;

package/dist/schema/record.d.ts

@@ -27,14 +27,14 @@ export interface XataRecord extends Identifiable {
     /**
      * Retrieves a refreshed copy of the current record from the database.
      */
-    read(): Promise<SelectedPick<this, ['*']> | null>;
+    read(): Promise<Readonly<SelectedPick<this, ['*']>> | null>;
     /**
      * 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.
      * @returns A new record containing the latest values for all the columns of the current record.
      */
-    update(data: Partial<EditableData<Omit<this, keyof XataRecord>>>): Promise<SelectedPick<this, ['*']>>;
+    update(partialUpdate: Partial<EditableData<Omit<this, keyof XataRecord>>>): Promise<Readonly<SelectedPick<this, ['*']>>>;
     /**
      * Performs a deletion of the current record in the database.
      *
@@ -46,14 +46,14 @@ export declare type Link<Record extends XataRecord> = Omit<XataRecord, 'read' |
     /**
      * Retrieves a refreshed copy of the current record from the database.
      */
-    read(): Promise<SelectedPick<Record, ['*']> | null>;
+    read(): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
     /**
      * 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.
      * @returns A new record containing the latest values for all the columns of the current record.
      */
-    update(data: Partial<EditableData<Omit<Record, keyof XataRecord>>>): Promise<SelectedPick<Record, ['*']>>;
+    update(partialUpdate: Partial<EditableData<Omit<Record, keyof XataRecord>>>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
 };
 export declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
 export declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;

package/dist/schema/repository.d.ts

@@ -1,59 +1,62 @@
-import { FetchImpl } from '../api/fetcher';
+import { SchemaPluginResult } from '.';
+import { FetcherExtraProps } from '../api/fetcher';
+import { Dictionary } 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.
  */
-export declare abstract class Repository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> {
-    abstract create(object: EditableData<Data> & Partial<Identifiable>): Promise<SelectedPick<Record, ['*']>>;
+export declare abstract class Repository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, Readonly<SelectedPick<Record, ['*']>>> {
+    abstract create(object: EditableData<Data> & Partial<Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
     /**
      * Creates a single record in the table 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 create(id: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
+    abstract create(id: string, object: EditableData<Data>): Promise<Readonly<SelectedPick<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 create(objects: Array<EditableData<Data> & Partial<Identifiable>>): Promise<SelectedPick<Record, ['*']>[]>;
+    abstract create(objects: Array<EditableData<Data> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<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<SelectedPick<Record, ['*']> | null>;
+    abstract read(id: string): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
     /**
      * Partially update a single record.
      * @param object An object with its id and the columns to be updated.
      * @returns The full persisted record.
      */
-    abstract update(object: Partial<EditableData<Data>> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
+    abstract update(object: Partial<EditableData<Data>> & Identifiable): Promise<Readonly<SelectedPick<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 updated.
      * @returns The full persisted record.
      */
-    abstract update(id: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
+    abstract update(id: string, object: Partial<EditableData<Data>>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
     /**
      * Partially updates multiple records.
      * @param objects An array of objects with their ids and columns to be updated.
      * @returns Array of the persisted records.
      */
-    abstract update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;
+    abstract update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
     /**
      * Creates or updates a single record. If a record exists with the given id,
      * it will be update, otherwise a new record will be created.
      * @param object Object containing the column names with their values to be persisted in the table.
      * @returns The full persisted record.
      */
-    abstract createOrUpdate(object: EditableData<Data> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
+    abstract createOrUpdate(object: EditableData<Data> & Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
     /**
      * Creates or updates a single record. If a record exists with the given id,
      * it will be update, otherwise a new record will be created.
@@ -61,14 +64,14 @@ export declare abstract class Repository<Data extends BaseData, Record extends X
      * @param object The column names and the values to be persisted.
      * @returns The full persisted record.
      */
-    abstract createOrUpdate(id: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
+    abstract createOrUpdate(id: string, object: EditableData<Data>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
     /**
      * Creates or updates a single record. If a record exists with the given id,
      * it will be update, otherwise a new record will be created.
      * @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 createOrUpdate(objects: Array<EditableData<Data> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;
+    abstract createOrUpdate(objects: Array<EditableData<Data> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
     /**
      * Deletes a record given its unique id.
      * @param id The unique id.
@@ -93,11 +96,26 @@ 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, ['*']>> {
+export declare class RestRepository<Data extends BaseData, Record extends XataRecord = Data & XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> implements Repository<Data, Record> {
     #private;
-    constructor(client: BaseClient<any>, table: string);
+    db: SchemaPluginResult<any>;
+    constructor(options: {
+        table: string;
+        links?: LinkDictionary;
+        getFetchProps: () => Promise<FetcherExtraProps>;
+        db: SchemaPluginResult<any>;
+    });
     create(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
     create(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
     create(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
@@ -109,40 +127,9 @@ 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>;
-}
-export declare class RestRespositoryFactory implements RepositoryFactory {
-    createRepository<Data extends BaseData>(client: BaseClient<any>, table: string): Repository<Data & XataRecord>;
-}
-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 implementation. This option is only required if the runtime does not include a fetch implementation
-     * available in the global scope. If you are running your code on Deno or Cloudflare workers for example,
-     * you won't need to provide a specific fetch implementation. But for most versions of Node.js you'll need
-     * to provide one. Such as cross-fetch, node-fetch or isomorphic-fetch.
-     */
-    fetch?: FetchImpl;
-    databaseURL?: string;
-    branch?: BranchStrategyOption;
-    /**
-     * API key to be used. You can create one in your account settings at https://app.xata.io/settings.
-     */
-    apiKey?: string;
-    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>;
-}
 export {};