@xata.io/client 0.1.4 → 0.1.5

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 export interface XataRecord {
-    _id: string;
-    _version: number;
+    id: string;
+    xata: {
+        version: number;
+    };
     read(): Promise<this>;
     update(data: Selectable<this>): Promise<this>;
     delete(): Promise<void>;
@@ -17,32 +19,34 @@ export declare type OmitLinks<T> = {
 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' | '_version'>;
+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> = Partial<Record<Operator, T>>;
+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) => Partial<Record<Operator, T>>;
-export declare const ge: <T extends ComparableType>(value: T) => Partial<Record<Operator, T>>;
-export declare const gte: <T extends ComparableType>(value: T) => Partial<Record<Operator, T>>;
-export declare const lt: <T extends ComparableType>(value: T) => Partial<Record<Operator, T>>;
-export declare const lte: <T extends ComparableType>(value: T) => Partial<Record<Operator, T>>;
-export declare const le: <T extends ComparableType>(value: T) => Partial<Record<Operator, T>>;
+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) => Partial<Record<Operator, T>>;
-export declare const isNot: <T>(value: T) => Partial<Record<Operator, T>>;
-export declare const contains: <T>(value: T) => Partial<Record<Operator, T>>;
+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>;

package/dist/index.js

@@ -223,8 +223,8 @@ class RestRepository extends Repository {
             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;
+                if (value && typeof value === 'object' && typeof value.id === 'string') {
+                    body[key] = value.id;
                 }
             }
             const obj = yield this.request('POST', `/tables/${this.table}/data`, body);
@@ -292,15 +292,15 @@ class BaseClient {
             const [field, linkTable] = link;
             const value = o[field];
             if (value && typeof value === 'object') {
-                const { _id } = value;
-                if (Object.keys(value).find((col) => !col.startsWith('_'))) {
+                const { id } = value;
+                if (Object.keys(value).find((col) => col === 'id')) {
                     o[field] = this.initObject(linkTable, value);
                 }
-                else if (_id) {
+                else if (id) {
                     o[field] = {
-                        _id,
+                        id,
                         get: () => {
-                            this.db[linkTable].read(_id);
+                            this.db[linkTable].read(id);
                         }
                     };
                 }
@@ -308,13 +308,13 @@ class BaseClient {
         }
         const db = this.db;
         o.read = function () {
-            return db[table].read(o['_id']);
+            return db[table].read(o['id']);
         };
         o.update = function (data) {
-            return db[table].update(o['_id'], data);
+            return db[table].update(o['id'], data);
         };
         o.delete = function () {
-            return db[table].delete(o['_id']);
+            return db[table].delete(o['id']);
         };
         for (const prop of ['read', 'update', 'delete']) {
             Object.defineProperty(o, prop, { enumerable: false });

package/dist/index.test.js

@@ -125,11 +125,11 @@ describe('query', () => {
     });
     describe('getOne', () => {
         test('returns a single object', () => __awaiter(void 0, void 0, void 0, function* () {
-            const result = { records: [{ _id: '1234' }] };
+            const result = { records: [{ id: '1234' }] };
             const expected = { method: 'POST', path: '/tables/users/query', body: {} };
             expectRequest(expected, () => __awaiter(void 0, void 0, void 0, function* () {
                 const first = yield users.select().getOne();
-                expect(first === null || first === void 0 ? void 0 : first._id).toBe(result.records[0]._id);
+                expect(first === null || first === void 0 ? void 0 : first.id).toBe(result.records[0].id);
             }), result);
         }));
         test('returns null if no objects are returned', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -151,12 +151,12 @@ describe('read', () => {
 });
 describe('Repository.update', () => {
     test('updates and object successfully', () => __awaiter(void 0, void 0, void 0, function* () {
-        const object = { _id: 'rec_1234', _version: 1, name: 'Ada' };
-        const expected = { method: 'PUT', path: `/tables/users/data/${object._id}`, body: object };
+        const object = { id: 'rec_1234', xata: { version: 1 }, name: 'Ada' };
+        const expected = { method: 'PUT', path: `/tables/users/data/${object.id}`, body: object };
         expectRequest(expected, () => __awaiter(void 0, void 0, void 0, function* () {
-            const result = yield users.update(object._id, object);
-            expect(result._id).toBe(object._id);
-        }), { _id: object._id });
+            const result = yield users.update(object.id, object);
+            expect(result.id).toBe(object.id);
+        }), { id: object.id });
     }));
 });
 describe('Repository.delete', () => {
@@ -171,12 +171,12 @@ describe('Repository.delete', () => {
 });
 describe('create', () => {
     test('successful', () => __awaiter(void 0, void 0, void 0, function* () {
-        const created = { _id: 'rec_1234', _version: 0 };
+        const created = { id: 'rec_1234', _version: 0 };
         const object = { name: 'Ada' };
         const expected = { method: 'POST', path: '/tables/users/data', body: object };
         expectRequest(expected, () => __awaiter(void 0, void 0, void 0, function* () {
             const result = yield users.create(object);
-            expect(result._id).toBe(created._id);
+            expect(result.id).toBe(created.id);
         }), created);
     }));
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xata.io/client",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Xata.io SDK for TypeScript and JavaScript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/src/index.test.ts

@@ -145,13 +145,13 @@ describe('query', () => {
 
   describe('getOne', () => {
     test('returns a single object', async () => {
-      const result = { records: [{ _id: '1234' }] };
+      const result = { records: [{ id: '1234' }] };
       const expected = { method: 'POST', path: '/tables/users/query', body: {} };
       expectRequest(
         expected,
         async () => {
           const first = await users.select().getOne();
-          expect(first?._id).toBe(result.records[0]._id);
+          expect(first?.id).toBe(result.records[0].id);
         },
         result
       );
@@ -182,15 +182,15 @@ describe('read', () => {
 
 describe('Repository.update', () => {
   test('updates and object successfully', async () => {
-    const object = { _id: 'rec_1234', _version: 1, name: 'Ada' } as User;
-    const expected = { method: 'PUT', path: `/tables/users/data/${object._id}`, body: object };
+    const object = { id: 'rec_1234', xata: { version: 1 }, name: 'Ada' } as User;
+    const expected = { method: 'PUT', path: `/tables/users/data/${object.id}`, body: object };
     expectRequest(
       expected,
       async () => {
-        const result = await users.update(object._id, object);
-        expect(result._id).toBe(object._id);
+        const result = await users.update(object.id, object);
+        expect(result.id).toBe(object.id);
       },
-      { _id: object._id }
+      { id: object.id }
     );
   });
 });
@@ -207,14 +207,14 @@ describe('Repository.delete', () => {
 
 describe('create', () => {
   test('successful', async () => {
-    const created = { _id: 'rec_1234', _version: 0 };
+    const created = { id: 'rec_1234', _version: 0 };
     const object = { name: 'Ada' } as User;
     const expected = { method: 'POST', path: '/tables/users/data', body: object };
     expectRequest(
       expected,
       async () => {
         const result = await users.create(object);
-        expect(result._id).toBe(created._id);
+        expect(result.id).toBe(created.id);
       },
       created
     );

package/src/index.ts

@@ -1,6 +1,8 @@
 export interface XataRecord {
-  _id: string;
-  _version: number;
+  id: string;
+  xata: {
+    version: number;
+  };
   read(): Promise<this>;
   update(data: Selectable<this>): Promise<this>;
   delete(): Promise<void>;
@@ -23,7 +25,7 @@ export type OmitMethods<T> = {
   [key in keyof T as T[key] extends Function ? never : key]: T[key];
 };
 
-export type Selectable<T> = Omit<OmitQueries<OmitMethods<T>>, '_id' | '_version'>;
+export type Selectable<T> = Omit<OmitQueries<OmitMethods<T>>, 'id' | 'xata'>;
 
 export type Select<T, K extends keyof T> = Pick<T, K> & Queries<T> & XataRecord;
 
@@ -53,7 +55,7 @@ type Operator =
 
 // TODO: restrict constraints depending on type?
 // E.g. startsWith cannot be used with numbers
-type Constraint<T> = Partial<Record<Operator, T>>;
+type Constraint<T> = { [key in Operator]?: T };
 
 type DeepConstraint<T> = T extends Record<string, any>
   ? {
@@ -338,8 +340,8 @@ export class RestRepository<T> extends Repository<T> {
     const body = { ...object } as Record<string, unknown>;
     for (const key of Object.keys(body)) {
       const value = body[key];
-      if (value && typeof value === 'object' && typeof (value as Record<string, unknown>)._id === 'string') {
-        body[key] = (value as XataRecord)._id;
+      if (value && typeof value === 'object' && typeof (value as Record<string, unknown>).id === 'string') {
+        body[key] = (value as XataRecord).id;
       }
     }
     const obj = await this.request('POST', `/tables/${this.table}/data`, body);
@@ -418,14 +420,14 @@ export class BaseClient<D extends Record<string, Repository<any>>> {
       const value = o[field];
 
       if (value && typeof value === 'object') {
-        const { _id } = value as any;
-        if (Object.keys(value).find((col) => !col.startsWith('_'))) {
+        const { id } = value as any;
+        if (Object.keys(value).find((col) => col === 'id')) {
           o[field] = this.initObject(linkTable, value);
-        } else if (_id) {
+        } else if (id) {
           o[field] = {
-            _id,
+            id,
             get: () => {
-              this.db[linkTable].read(_id);
+              this.db[linkTable].read(id);
             }
           };
         }
@@ -434,13 +436,13 @@ export class BaseClient<D extends Record<string, Repository<any>>> {
 
     const db = this.db;
     o.read = function () {
-      return db[table].read(o['_id'] as string);
+      return db[table].read(o['id'] as string);
     };
     o.update = function (data: any) {
-      return db[table].update(o['_id'] as string, data);
+      return db[table].update(o['id'] as string, data);
     };
     o.delete = function () {
-      return db[table].delete(o['_id'] as string);
+      return db[table].delete(o['id'] as string);
     };
 
     for (const prop of ['read', 'update', 'delete']) {