@xata.io/client 0.0.0-beta.f46df88 → 0.0.0-beta.f65b504

package/dist/schema/filters.spec.js

@@ -0,0 +1,177 @@
+"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
+const singleColumnWithExplicitIs = { name: { $is: 'r2' } };
+// Is string
+const isString = { string: 'string' };
+// Is true
+const isTrue = { boolean: true };
+// Is false
+const isFalse = { boolean: false };
+// Is pos int
+const isPosInt = { number: 1234567 };
+// Is neg int
+const isNegInt = { number: -42 };
+// Is float
+const isFloat = { number: 3.14 };
+//  with dots
+const withDots = { 'settings.plan': 'free' };
+// Nested columns
+const nestedColumns = { settings: { plan: 'free' } };
+// Nested columns array
+const nestedColumnsArray = { settings: [{ dark: false }, { plan: 'free' }] };
+// Nested columns any
+const nestedColumnsAny = { settings: { $any: [{ plan: 'free' }, { plan: 'trial' }] } };
+// Nested columns any value
+const nestedColumnsAnyValue = { settings: { plan: { $any: ['free', 'trial'] } } };
+// Or with $any
+const orWithAny = { 'settings.plan': { $any: ['free', 'paid'] } };
+// Multiple columns implicit and
+const multipleColumnsImplicitAnd = { 'settings.dark': true, 'settings.plan': 'free' };
+// Explicit $all with multi-key filter list
+const explicitAllWithMultiKeyFilterList = {
+    $all: { 'settings.dark': true, 'settings.plan': 'free' }
+};
+// Explicit $all with filter list
+const explicitAllWithFilterList = {
+    $all: [{ 'settings.dark': true }, { 'settings.plan': 'free' }]
+};
+// Explicit $any with multi-key filter list
+const explicitAnyWithMultiKeyFilterList = {
+    $all: { 'settings.dark': true, 'settings.plan': 'free' }
+};
+// Explicit $any with filter list
+const explicitAnyWithFilterList = {
+    $any: [{ 'settings.dark': true }, { 'settings.plan': 'free' }]
+};
+// $any with multiple values
+const anyWithMultipleValues = { number: { $any: [1, 2, 3] } };
+// $none with multiple values
+const noneWithMultipleValues = { number: { $none: [1, 2, 3] } };
+// Exists filter
+const existsFilter = { $exists: 'test' };
+// Not exists filter
+const notExistsFilter = { $notExists: 'test' };
+// Exists with all
+const existsWithAll = { $all: [{ $exists: 'settings' }, { $exists: 'name' }] };
+// Nest any with not
+const nestAnyWithNot = { $not: { $any: { 'settings.dark': true, 'settings.plan': 'free' } } };
+// Mix $all and $any with extra keys
+const mixAllAndAnyWithExtraKeys = {
+    $all: { $any: { 'settings.dark': false, 'settings.plan': 'free' }, name: 'r1' }
+};
+// Range query with less first
+const rangeQueryWithLessFirst = { age: { $lt: 30, $ge: 20 } };
+// Range query with greater first
+const rangeQueryWithGreaterFirst = { age: { $ge: 20, $lt: 30 } };
+// Ordered op
+const orderedOp = { age: { $lt: 30 } };
+// Simple includes
+const simpleIncludes = { labels: { $includes: 'test' } };
+// Simple includes with op
+const simpleIncludesWithOp = { labels: { $includes: { $contains: 'test' } } };
+// Simple includes multiple
+const simpleIncludesMultiple = { labels: { $includes: ['a', 'b', 'c'] } };
+// Simple includes multiple with op
+const simpleIncludesMultipleWithOp = {
+    labels: { $includes: [{ $is: 'a' }, { $is: 'b' }, { $is: 'c' }] }
+};
+// Includes with many comparisons
+const includesWithManyComparisons = {
+    labels: { $includes: { $all: [{ $contains: 'a' }, { $contains: 'b' }] } }
+};
+// Simple includes multiple op and value
+const simpleIncludesMultipleOpAndValue = { labels: { $includes: [{ $contains: 'a' }, 'b'] } };
+// Includes with mode and array of filters
+const includesWithModeAndArrayOfFilters = {
+    labels: { $includesNone: [{ $contains: 'test' }, 'abc', { $endsWith: 'bad' }] }
+};
+// Includes with mix of any and all in predicate position
+const includesWithMixOfAnyAndAllInPredicatePosition = {
+    labels: { $includes: { $any: { $all: [{ $startsWith: 'test' }, { $contains: 'x' }], $any: ['a', 'b'] } } }
+};
+// Simple $includesany
+const simpleIncludesAny = { labels: { $includesAny: 'test' } };
+// Simple $includesall
+const simpleIncludesAll = { labels: { $includesAll: 'test' } };
+// Simple $includesnone
+const simpleIncludesNone = { labels: { $includesNone: 'test' } };
+// Exists value must be string not int
+// @ts-expect-error
+const existsValueMustBeStringNotInt = { $exists: 42 };
+// Exists value must be string not objct
+// @ts-expect-error
+const existsValueMustBeStringNotObject = { $exists: { field: 'settings.unknown' } };
+// Filter by one column
+const filterByOneColumn = { name: 'r1' };
+// Filter with the $is operator
+const filterWithTheIsOperator = { name: { $is: 'r1' } };
+// Filter with dot notation
+const filterWithDotNotation = { 'settings.plan': 'free' };
+// Filter with nested object
+const filterWithNestedObject = { 'settings.plan': { $is: 'free' } };
+// Filter with $any operation
+const filterWithAnyOperation = { 'settings.plan': { $any: ['free', 'paid'] } };
+// Filter with and operations
+const filterWithAndOperations = { 'settings.dark': true, 'settings.plan': 'free' };
+// Filter with both and and any operations
+const filterWithBothAndAndAnyOperations = {
+    $any: { 'settings.dark': true, 'settings.plan': 'free' }
+};
+// Filter with both and and any operations in array
+const filterWithBothAndAndAnyOperationsInArray = { $any: [{ name: 'r1' }, { name: 'r2' }] };
+// Filter with exists operation
+const filterWithExistsOperation = { $exists: 'settings' };
+// Filter with exists, and and any operations
+const filterWithExistsAndAndAnyOperations = {
+    $all: [{ $exists: 'settings' }, { $exists: 'name' }]
+};
+// Filter with not exists operation
+const filterWithNotExistsOperation = { $notExists: 'settings' };
+// Filter with partial match
+const filterWithPartialMatch = { name: { $contains: 'value' } };
+// Filter with pattern operator
+const filterWithPatternOperator = { name: { $pattern: 'value' } };
+// Filter with $startsWith and $endsWith operators
+const filterWithStartsWithAndEndsWithOperators = {
+    name: { $startsWith: 'value', $endsWith: 'value' }
+};
+// Filter with numeric ranges
+const filterWithNumericRanges = { age: { $lt: 30, $ge: 20 } };
+// Filter with negations
+const filterWithNegations = { $not: { name: 'r1' } };
+// Filter with complex negations
+const filterWithComplexNegations = { $not: { $any: [{ name: 'r1' }, { name: 'r2' }] } };
+// Filter with arrays complex negations
+const filterWithArraysComplexNegations = {
+    labels: {
+        $includes: {
+            $all: [{ $contains: 'label' }, { $not: { $endsWith: '-debug' } }]
+        }
+    }
+};
+// Filters with $includesAll
+const filtersWithIncludesAll = {
+    'settings.labels': {
+        $includesAll: [{ $contains: 'label' }]
+    }
+};
+// Filter with invalid property type
+// @ts-expect-error
+const filterWithInvalidPropertyType = { name: 42 };
+// Filter with invalid dot notation property type
+// @ts-expect-error
+const filterWithInvalidNestedPropertyType = { 'settings.plan': 42 };
+// Filter with invalid nested object property type
+// @ts-expect-error
+const filterWithInvalidNestedObjectPropertyType = { settings: { plan: 42 } };
+// Filter with invalid property $is type
+// @ts-expect-error
+const filterWithInvalidOperator = { name: { $is: 42 } };
+(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,21 @@
+import { Namespace, NamespaceBuildOptions } from '../namespace';
+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 { Repository, RestRepository } from './repository';
+export declare type SchemaDefinition = {
+    table: string;
+    links?: LinkDictionary;
+};
+export declare type SchemaNamespaceResult<Schemas extends Record<string, BaseData>> = {
+    [Key in keyof Schemas]: Repository<Schemas[Key]>;
+};
+export declare class SchemaNamespace<Schemas extends Record<string, BaseData>> extends Namespace {
+    private links?;
+    constructor(links?: LinkDictionary | undefined);
+    build(options: NamespaceBuildOptions): SchemaNamespaceResult<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.SchemaNamespace = exports.RestRepository = exports.Repository = exports.isXataRecord = exports.isIdentifiable = exports.Query = void 0;
+const namespace_1 = require("../namespace");
+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,25 @@ 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; } });
+class SchemaNamespace extends namespace_1.Namespace {
+    constructor(links) {
+        super();
+        this.links = links;
+    }
+    build(options) {
+        const { getFetchProps } = options;
+        const links = this.links;
+        const schemaNamespace = new Proxy({}, {
+            get: (_target, table) => {
+                if (!(0, lang_1.isString)(table))
+                    throw new Error('Invalid table name');
+                return new repository_1.RestRepository({ schemaNamespace, getFetchProps, table, links });
+            }
+        });
+        return schemaNamespace;
+    }
+}
+exports.SchemaNamespace = SchemaNamespace;

package/dist/schema/operators.d.ts

@@ -1,72 +1,74 @@
-import { Constraint } from './filters';
-declare type ComparableType = number | Date;
+import { ArrayFilter, ComparableType, ComparableTypeFilter, ExistanceFilter, PropertyFilter, StringTypeFilter } from './filters';
+import { SelectableColumn } from './selection';
 /**
  * Operator to restrict results to only values that are greater than the given value.
  */
-export declare const gt: <T extends ComparableType>(value: T) => Constraint<T>;
+export declare const gt: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are greater than or equal to the given value.
  */
-export declare const ge: <T extends ComparableType>(value: T) => Constraint<T>;
+export declare const ge: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are greater than or equal to the given value.
  */
-export declare const gte: <T extends ComparableType>(value: T) => Constraint<T>;
+export declare const gte: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are lower than the given value.
  */
-export declare const lt: <T extends ComparableType>(value: T) => Constraint<T>;
+export declare const lt: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are lower than or equal to the given value.
  */
-export declare const lte: <T extends ComparableType>(value: T) => Constraint<T>;
+export declare const lte: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are lower than or equal to the given value.
  */
-export declare const le: <T extends ComparableType>(value: T) => Constraint<T>;
+export declare const le: <T extends ComparableType>(value: T) => ComparableTypeFilter<T>;
 /**
  * Operator to restrict results to only values that are not null.
  */
-export declare const exists: (column: string) => Constraint<string>;
+export declare const exists: <T>(column: SelectableColumn<T, []>) => ExistanceFilter<T>;
 /**
  * Operator to restrict results to only values that are null.
  */
-export declare const notExists: (column: string) => Constraint<string>;
+export declare const notExists: <T>(column: SelectableColumn<T, []>) => ExistanceFilter<T>;
 /**
  * Operator to restrict results to only values that start with the given prefix.
  */
-export declare const startsWith: (value: string) => Constraint<string>;
+export declare const startsWith: (value: string) => StringTypeFilter;
 /**
  * Operator to restrict results to only values that end with the given suffix.
  */
-export declare const endsWith: (value: string) => Constraint<string>;
+export declare const endsWith: (value: string) => StringTypeFilter;
 /**
  * Operator to restrict results to only values that match the given pattern.
  */
-export declare const pattern: (value: string) => Constraint<string>;
+export declare const pattern: (value: string) => StringTypeFilter;
 /**
  * Operator to restrict results to only values that are equal to the given value.
  */
-export declare const is: <T>(value: T) => Constraint<T>;
+export declare const is: <T>(value: T) => PropertyFilter<T>;
 /**
  * Operator to restrict results to only values that are not equal to the given value.
  */
-export declare const isNot: <T>(value: T) => Constraint<T>;
+export declare const isNot: <T>(value: T) => PropertyFilter<T>;
 /**
  * Operator to restrict results to only values that contain the given value.
  */
-export declare const contains: <T>(value: T) => Constraint<T>;
+export declare const contains: (value: string) => StringTypeFilter;
 /**
- * Operator to restrict results to only arrays that include the given value.
+ * Operator to restrict results if some array items match the predicate.
  */
-export declare const includes: (value: string) => Constraint<string>;
+export declare const includes: <T>(value: T) => ArrayFilter<T>;
 /**
- * Operator to restrict results to only arrays that include a value matching the given substring.
+ * Operator to restrict results if all array items match the predicate.
  */
-export declare const includesSubstring: (value: string) => Constraint<string>;
+export declare const includesAll: <T>(value: T) => ArrayFilter<T>;
 /**
- * Operator to restrict results to only arrays that include a value matching the given pattern.
+ * Operator to restrict results if none array items match the predicate.
  */
-export declare const includesPattern: (value: string) => Constraint<string>;
-export declare const includesAll: (value: string) => Constraint<string>;
-export {};
+export declare const includesNone: <T>(value: T) => ArrayFilter<T>;
+/**
+ * Operator to restrict results if some array items match the predicate.
+ */
+export declare const includesAny: <T>(value: T) => ArrayFilter<T>;

package/dist/schema/operators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.includesAny = exports.includesNone = exports.includesAll = 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;
 /**
  * Operator to restrict results to only values that are greater than the given value.
  */
@@ -71,21 +71,23 @@ exports.isNot = isNot;
  */
 const contains = (value) => ({ $contains: value });
 exports.contains = contains;
-// TODO: these can only be applied to columns of type "multiple"
 /**
- * Operator to restrict results to only arrays that include the given value.
+ * Operator to restrict results if some array items match the predicate.
  */
 const includes = (value) => ({ $includes: value });
 exports.includes = includes;
 /**
- * Operator to restrict results to only arrays that include a value matching the given substring.
+ * Operator to restrict results if all array items match the predicate.
  */
-const includesSubstring = (value) => ({ $includesSubstring: value });
-exports.includesSubstring = includesSubstring;
-/**
- * Operator to restrict results to only arrays that include a value matching the given pattern.
- */
-const includesPattern = (value) => ({ $includesPattern: value });
-exports.includesPattern = includesPattern;
 const includesAll = (value) => ({ $includesAll: value });
 exports.includesAll = includesAll;
+/**
+ * Operator to restrict results if none array items match the predicate.
+ */
+const includesNone = (value) => ({ $includesNone: value });
+exports.includesNone = includesNone;
+/**
+ * Operator to restrict results if some array items match the predicate.
+ */
+const includesAny = (value) => ({ $includesAny: value });
+exports.includesAny = includesAny;

package/dist/schema/query.d.ts

@@ -1,10 +1,11 @@
 import { FilterExpression } from '../api/schemas';
 import { NonEmptyArray, RequiredBy } from '../util/types';
-import { DeepConstraint, FilterConstraints, SortDirection, SortFilter } from './filters';
+import { Filter } from './filters';
 import { Page, Paginable, PaginationOptions, PaginationQueryMeta } from './pagination';
 import { XataRecord } from './record';
 import { Repository } from './repository';
 import { SelectableColumn, SelectedPick, ValueAtColumn } from './selection';
+import { SortDirection, SortFilter } from './sorting';
 export declare type QueryOptions<T extends XataRecord> = {
     page?: PaginationOptions;
     columns?: NonEmptyArray<SelectableColumn<T>>;
@@ -28,25 +29,25 @@ export declare class Query<Record extends XataRecord, Result extends XataRecord
      * @param queries An array of subqueries.
      * @returns A new Query object.
      */
-    any(...queries: Query<Record, Result>[]): Query<Record, Result>;
+    any(...queries: Query<Record, any>[]): Query<Record, Result>;
     /**
      * Builds a new query object representing a logical AND between the given subqueries.
      * @param queries An array of subqueries.
      * @returns A new Query object.
      */
-    all(...queries: Query<Record, Result>[]): Query<Record, Result>;
+    all(...queries: Query<Record, any>[]): Query<Record, Result>;
     /**
      * Builds a new query object representing a logical OR negating each subquery. In pseudo-code: !q1 OR !q2
      * @param queries An array of subqueries.
      * @returns A new Query object.
      */
-    not(...queries: Query<Record, Result>[]): Query<Record, Result>;
+    not(...queries: Query<Record, any>[]): Query<Record, Result>;
     /**
      * Builds a new query object representing a logical AND negating each subquery. In pseudo-code: !q1 AND !q2
      * @param queries An array of subqueries.
      * @returns A new Query object.
      */
-    none(...queries: Query<Record, Result>[]): Query<Record, Result>;
+    none(...queries: Query<Record, any>[]): Query<Record, Result>;
     /**
      * Builds a new query object adding one or more constraints. Examples:
      *
@@ -60,11 +61,10 @@ export declare class Query<Record extends XataRecord, Result extends XataRecord
      * })
      * ```
      *
-     * @param constraints
      * @returns A new Query object.
      */
-    filter(constraints: FilterConstraints<Record>): Query<Record, Result>;
-    filter<F extends SelectableColumn<Record>>(column: F, value: FilterConstraints<ValueAtColumn<Record, F>> | DeepConstraint<ValueAtColumn<Record, F>>): Query<Record, Result>;
+    filter(filters: Filter<Record>): Query<Record, Result>;
+    filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
     /**
      * Builds a new query with a new sort option.
      * @param column The column name.

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>;
@@ -62,5 +62,5 @@ export declare type EditableData<O extends BaseData> = {
         id: string;
     } : NonNullable<O[K]> extends XataRecord ? {
         id: string;
-    } | undefined : O[K];
+    } | null | undefined : O[K];
 };