@xata.io/client - npm Package Compare versions

Comparing version 0.0.0-alpha.587d884 to 0.0.0-alpha.59578d6

dist/index.d.ts

@@ -57,11 +57,47 @@ export interface XataRecord {
 };
+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> = {
-    filter?: FilterConstraints<T>;
-    sort?: {
-        column: keyof T;
-        direction?: SortDirection;
-    } | keyof T;
+    page?: PaginationOptions;
 };
 declare type QueryOrConstraint<T, R> = Query<T, R> | Constraint<T>;
-export declare class Query<T, R = 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;
@@ -74,2 +110,5 @@ repository: Repository<T>;
     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>);
@@ -83,6 +122,14 @@ any(...queries: Query<T, R>[]): 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?: BulkQueryOptions<T>): Promise<R | null>;
+    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;
 }
@@ -92,18 +139,20 @@ export declare abstract class Repository<T> extends Query<T, Selectable<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 delete(id: string): void;
-    abstract query<R>(query: Query<T, R>): Promise<R[]>;
+    abstract _runQuery<R>(query: Query<T, R>, options?: BulkQueryOptions<T>): Promise<Page<T, R>>;
 }
 export declare class RestRepository<T> extends Repository<T> {
     client: BaseClient<any>;
-    fetch: any;
+    fetchImpl: any;
     constructor(client: BaseClient<any>, table: string);
-    request(method: string, path: string, body?: unknown): Promise<any>;
+    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>;
+    createMany(objects: T[]): Promise<T[]>;
     read(id: string): Promise<T | null>;
     update(id: string, object: Partial<T>): Promise<T>;
     delete(id: string): Promise<void>;
-    query<R>(query: Query<T, R>): Promise<R[]>;
+    _runQuery<R>(query: Query<T, R>, options?: BulkQueryOptions<T>): Promise<Page<T, R>>;
 }
@@ -122,3 +171,3 @@ interface RepositoryFactory {
     fetch?: unknown;
-    databaseURL: string;
+    databaseURL?: string;
     branch: BranchStrategyOption;
@@ -125,0 +174,0 @@ apiKey: string;

dist/index.js

@@ -18,2 +18,14 @@ "use strict";
 };
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -58,4 +70,39 @@ exports.XataError = exports.BaseClient = exports.RestRespositoryFactory = exports.RestRepository = exports.Repository = exports.Query = exports.includesAll = exports.includesPattern = exports.includesSubstring = exports.includes = exports.contains = exports.isNot = exports.is = exports.pattern = exports.endsWith = exports.startsWith = exports.notExists = exports.exists = exports.le = exports.lte = exports.lt = exports.gte = exports.ge = exports.gt = void 0;
 exports.includesAll = includesAll;
+class Page {
+    constructor(query, meta, records = []) {
+        this.query = query;
+        this.meta = meta;
+        this.records = records;
+    }
+    nextPage(size, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.query.getPaginated({ page: { size, offset, after: this.meta.page.cursor } });
+        });
+    }
+    previousPage(size, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.query.getPaginated({ page: { size, offset, before: this.meta.page.cursor } });
+        });
+    }
+    firstPage(size, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.query.getPaginated({ page: { size, offset, first: this.meta.page.cursor } });
+        });
+    }
+    lastPage(size, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.query.getPaginated({ page: { size, offset, last: this.meta.page.cursor } });
+        });
+    }
+    // TODO: We need to add something on the backend if we want a hasPreviousPage
+    hasNextPage() {
+        return this.meta.page.more;
+    }
+}
 class Query {
     constructor(repository, table, data, parent) {
+        // Cursor pagination
+        this.query = this;
+        this.meta = { page: { cursor: 'start', more: true } };
+        this.records = [];
         if (repository) {
@@ -133,15 +180,47 @@ this.repository = repository;
     }
-    // TODO: pagination. Maybe implement different methods for different type of paginations
-    // and one to simply get the first records returned by the query with no pagination.
+    getPaginated(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.repository._runQuery(this, options);
+        });
+    }
+    [Symbol.asyncIterator]() {
+        return __asyncGenerator(this, arguments, function* _a() {
+            var e_1, _b;
+            try {
+                for (var _c = __asyncValues(this.getIterator(1)), _d; _d = yield __await(_c.next()), !_d.done;) {
+                    const [record] = _d.value;
+                    yield yield __await(record);
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (_d && !_d.done && (_b = _c.return)) yield __await(_b.call(_c));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        });
+    }
+    getIterator(chunk, options = {}) {
+        return __asyncGenerator(this, arguments, function* getIterator_1() {
+            let offset = 0;
+            let end = false;
+            while (!end) {
+                const { records, meta } = yield __await(this.getPaginated(Object.assign(Object.assign({}, options), { page: { size: chunk, offset } })));
+                yield yield __await(records);
+                offset += chunk;
+                end = !meta.page.more;
+            }
+        });
+    }
     getMany(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            // TODO: use options
-            return this.repository.query(this);
+            const { records } = yield this.getPaginated(options);
+            return records;
         });
     }
-    getOne(options) {
+    getOne(options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            // TODO: use options
-            const arr = yield this.getMany(); // TODO, limit to 1
-            return arr[0] || null;
+            const records = yield this.getMany(Object.assign(Object.assign({}, options), { page: { size: 1 } }));
+            return records[0] || null;
         });
@@ -151,3 +230,3 @@ }
         return __awaiter(this, void 0, void 0, function* () {
-            // Return number of affected rows
+            // TODO: Return number of affected rows
             return 0;
@@ -160,2 +239,25 @@ });
     }
+    nextPage(size, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.firstPage(size, offset);
+        });
+    }
+    previousPage(size, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.firstPage(size, offset);
+        });
+    }
+    firstPage(size, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getPaginated({ page: { size, offset } });
+        });
+    }
+    lastPage(size, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getPaginated({ page: { size, offset, before: 'end' } });
+        });
+    }
+    hasNextPage() {
+        return this.meta.page.more;
+    }
 }
@@ -173,24 +275,8 @@ exports.Query = Query;
         this.client = client;
-        const { fetch } = client.options;
-        if (fetch) {
-            this.fetch = fetch;
-        }
-        else if (typeof window === 'object') {
-            this.fetch = window.fetch;
-        }
-        else if (typeof require === 'function') {
-            try {
-                this.fetch = require('node-fetch');
-            }
-            catch (err) {
-                try {
-                    this.fetch = require('cross-fetch');
-                }
-                catch (err) {
-                    throw new Error('No fetch implementation found. Please provide one in the constructor');
-                }
-            }
-        }
+        const fetchImpl = typeof fetch !== 'undefined' ? fetch : this.client.options.fetch;
+        if (!fetchImpl)
+            throw new Error('No fetch implementation provided');
+        this.fetchImpl = fetchImpl;
         Object.defineProperty(this, 'client', { enumerable: false });
-        Object.defineProperty(this, 'fetch', { enumerable: false });
+        Object.defineProperty(this, 'fetchImpl', { enumerable: false });
         Object.defineProperty(this, 'hostname', { enumerable: false });
@@ -202,3 +288,3 @@ }
             const branch = yield this.client.getBranch();
-            const resp = yield this.fetch(`${databaseURL}:${branch}${path}`, {
+            const resp = yield this.fetchImpl(`${databaseURL}:${branch}${path}`, {
                 method,
@@ -229,3 +315,3 @@ headers: {
             if (resp.status === 204)
-                return;
+                return undefined;
             return resp.json();
@@ -239,18 +325,36 @@ });
         return __awaiter(this, void 0, void 0, function* () {
-            const body = Object.assign({}, object);
-            for (const key of Object.keys(body)) {
-                const value = body[key];
-                if (value && typeof value === 'object' && typeof value.id === 'string') {
-                    body[key] = value.id;
-                }
+            const record = transformObjectLinks(object);
+            const response = yield this.request('POST', `/tables/${this.table}/data`, record);
+            if (!response) {
+                throw new Error("The server didn't return any data for the query");
             }
-            const obj = yield this.request('POST', `/tables/${this.table}/data`, body);
-            return this.client.initObject(this.table, obj);
+            const finalObject = yield this.read(response.id);
+            if (!finalObject) {
+                throw new Error('The server failed to save the record');
+            }
+            return finalObject;
         });
     }
+    createMany(objects) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const records = objects.map((object) => transformObjectLinks(object));
+            const response = yield this.request('POST', `/tables/${this.table}/bulk`, { records });
+            if (!response) {
+                throw new Error("The server didn't return any data for the query");
+            }
+            // TODO: Use filer.$any() to get all the records
+            const finalObjects = yield Promise.all(response.recordIDs.map((id) => this.read(id)));
+            if (finalObjects.some((object) => !object)) {
+                throw new Error('The server failed to save the record');
+            }
+            return finalObjects;
+        });
+    }
     read(id) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                const obj = yield this.request('GET', `/tables/${this.table}/data/${id}`);
-                return this.client.initObject(this.table, obj);
+                const response = yield this.request('GET', `/tables/${this.table}/data/${id}`);
+                if (!response)
+                    return null;
+                return this.client.initObject(this.table, response);
             }
@@ -266,4 +370,8 @@ catch (err) {
         return __awaiter(this, void 0, void 0, function* () {
-            const obj = yield this.request('PUT', `/tables/${this.table}/data/${id}`, object);
-            return this.client.initObject(this.table, obj);
+            const response = yield this.request('PUT', `/tables/${this.table}/data/${id}`, object);
+            if (!response) {
+                throw new Error("The server didn't return any data for the query");
+            }
+            // TODO: Review this, not sure we are properly initializing the object
+            return this.client.initObject(this.table, response);
         });
@@ -276,3 +384,3 @@ }
     }
-    query(query) {
+    _runQuery(query, options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -287,6 +395,12 @@ const filter = {
                 filter: Object.values(filter).some(Boolean) ? filter : undefined,
-                sort: query.$sort
+                sort: query.$sort,
+                page: options === null || options === void 0 ? void 0 : options.page
             };
-            const result = yield this.request('POST', `/tables/${this.table}/query`, body);
-            return result.records.map((record) => this.client.initObject(this.table, record));
+            const response = yield this.request('POST', `/tables/${this.table}/query`, body);
+            if (!response) {
+                throw new Error("The server didn't return any data for the query");
+            }
+            const { meta, records: objects } = response;
+            const records = objects.map((record) => this.client.initObject(this.table, record));
+            return new Page(query, meta, records);
         });
@@ -350,3 +464,3 @@ }
     getBranch() {
-        var e_1, _a;
+        var e_2, _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -370,3 +484,3 @@ if (this.branch)
             }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
             finally {
@@ -376,3 +490,3 @@ try {
                 }
-                finally { if (e_1) throw e_1.error; }
+                finally { if (e_2) throw e_2.error; }
             }
@@ -394,1 +508,10 @@ throw new Error('Unable to resolve branch value');
 };
+// TODO: We can find a better implementation for links
+const transformObjectLinks = (object) => {
+    return Object.entries(object).reduce((acc, [key, value]) => {
+        if (value && typeof value === 'object' && typeof value.id === 'string') {
+            return Object.assign(Object.assign({}, acc), { [key]: value.id });
+        }
+        return Object.assign(Object.assign({}, acc), { [key]: value });
+    }, {});
+};

package.json

 {
   "name": "@xata.io/client",
-  "version": "0.0.0-alpha.587d884",
+  "version": "0.0.0-alpha.59578d6",
   "description": "Xata.io SDK for TypeScript and JavaScript",
@@ -9,3 +9,3 @@ "main": "./dist/index.js",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc",
+    "build": "tsc -p tsconfig.build.json",
     "prepack": "npm run build"
@@ -24,3 +24,3 @@ },
   "homepage": "https://github.com/xataio/client-ts/blob/main/client/README.md",
-  "gitHead": "587d88410ac68b968f74f5af42be2d9947d4a73f"
+  "gitHead": "59578d6319d538c67c985b350596b03997aa136f"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Improved metrics

Number of low supply chain risk alerts

0

decreased by-100%

Number of medium supply chain risk alerts

3

decreased by-87.5%

Worsened metrics

Total package byte prevSize

42126

decreased by-43.26%

Number of package files

7

decreased by-30%

Lines of code

699

decreased by-56.31%

No dependency changes