@supabase/postgrest-js - npm Package Compare versions

Comparing version 0.27.0 to 0.28.0

dist/main/lib/PostgrestFilterBuilder.d.ts

@@ -111,3 +111,5 @@ import PostgrestTransformBuilder from './PostgrestTransformBuilder';
      */
-    cs(column: keyof T, value: string | T[keyof T][] | object): this;
+    contains(column: keyof T, value: string | T[keyof T][] | object): this;
+    /** @deprecated Use `contains()` instead. */
+    cs: (column: keyof T, value: string | T[keyof T][] | object) => this;
     /**
@@ -120,3 +122,5 @@ * Finds all rows whose json, array, or range value on the stated `column` is
      */
-    cd(column: keyof T, value: string | T[keyof T][] | object): this;
+    containedBy(column: keyof T, value: string | T[keyof T][] | object): this;
+    /** @deprecated Use `containedBy()` instead. */
+    cd: (column: keyof T, value: string | T[keyof T][] | object) => this;
     /**
@@ -129,3 +133,5 @@ * Finds all rows whose range value on the stated `column` is strictly to the
      */
-    sl(column: keyof T, range: string): this;
+    rangeLt(column: keyof T, range: string): this;
+    /** @deprecated Use `rangeLt()` instead. */
+    sl: (column: keyof T, range: string) => this;
     /**
@@ -138,3 +144,5 @@ * Finds all rows whose range value on the stated `column` is strictly to
      */
-    sr(column: keyof T, range: string): this;
+    rangeGt(column: keyof T, range: string): this;
+    /** @deprecated Use `rangeGt()` instead. */
+    sr: (column: keyof T, range: string) => this;
     /**
@@ -147,3 +155,5 @@ * Finds all rows whose range value on the stated `column` does not extend
      */
-    nxl(column: keyof T, range: string): this;
+    rangeGte(column: keyof T, range: string): this;
+    /** @deprecated Use `rangeGte()` instead. */
+    nxl: (column: keyof T, range: string) => this;
     /**
@@ -156,3 +166,5 @@ * Finds all rows whose range value on the stated `column` does not extend
      */
-    nxr(column: keyof T, range: string): this;
+    rangeLte(column: keyof T, range: string): this;
+    /** @deprecated Use `rangeLte()` instead. */
+    nxr: (column: keyof T, range: string) => this;
     /**
@@ -165,6 +177,8 @@ * Finds all rows whose range value on the stated `column` is adjacent to
      */
-    adj(column: keyof T, range: string): this;
+    rangeAdjacent(column: keyof T, range: string): this;
+    /** @deprecated Use `rangeAdjacent()` instead. */
+    adj: (column: keyof T, range: string) => this;
     /**
-     * Finds all rows whose array or range value on the stated `column` is
-     * contained by the specified `value`.
+     * Finds all rows whose array or range value on the stated `column` overlaps
+     * (has a value in common) with the specified `value`.
      *
@@ -174,4 +188,19 @@ * @param column  The column to filter on.
      */
-    ov(column: keyof T, value: string | T[keyof T][]): this;
+    overlaps(column: keyof T, value: string | T[keyof T][]): this;
+    /** @deprecated Use `overlaps()` instead. */
+    ov: (column: keyof T, value: string | T[keyof T][]) => this;
     /**
+     * Finds all rows whose text or tsvector value on the stated `column` matches
+     * the tsquery in `query`.
+     *
+     * @param column  The column to filter on.
+     * @param query  The Postgres tsquery string to filter with.
+     * @param config  The text search configuration to use.
+     * @param type  The type of tsquery conversion to use on `query`.
+     */
+    textSearch(column: keyof T, query: string, { config, type, }?: {
+        config?: string;
+        type?: 'plain' | 'phrase' | 'websearch' | null;
+    }): this;
+    /**
      * Finds all rows whose tsvector value on the stated `column` matches
@@ -183,2 +212,4 @@ * to_tsquery(`query`).
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` instead.
      */
@@ -195,2 +226,4 @@ fts(column: keyof T, query: string, { config }?: {
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` with `type: 'plain'` instead.
      */
@@ -207,2 +240,4 @@ plfts(column: keyof T, query: string, { config }?: {
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` with `type: 'phrase'` instead.
      */
@@ -219,2 +254,4 @@ phfts(column: keyof T, query: string, { config }?: {
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` with `type: 'websearch'` instead.
      */
@@ -221,0 +258,0 @@ wfts(column: keyof T, query: string, { config }?: {

dist/main/lib/PostgrestFilterBuilder.js

@@ -8,2 +8,21 @@ "use strict";
 class PostgrestFilterBuilder extends PostgrestTransformBuilder_1.default {
+    constructor() {
+        super(...arguments);
+        /** @deprecated Use `contains()` instead. */
+        this.cs = this.contains;
+        /** @deprecated Use `containedBy()` instead. */
+        this.cd = this.containedBy;
+        /** @deprecated Use `rangeLt()` instead. */
+        this.sl = this.rangeLt;
+        /** @deprecated Use `rangeGt()` instead. */
+        this.sr = this.rangeGt;
+        /** @deprecated Use `rangeGte()` instead. */
+        this.nxl = this.rangeGte;
+        /** @deprecated Use `rangeLte()` instead. */
+        this.nxr = this.rangeLte;
+        /** @deprecated Use `rangeAdjacent()` instead. */
+        this.adj = this.rangeAdjacent;
+        /** @deprecated Use `overlaps()` instead. */
+        this.ov = this.overlaps;
+    }
     /**
@@ -158,3 +177,3 @@ * Finds all rows which doesn't satisfy the filter.
      */
-    cs(column, value) {
+    contains(column, value) {
         if (typeof value === 'string') {
@@ -182,3 +201,3 @@ // range types can be inclusive '[', ']' or exclusive '(', ')' so just
      */
-    cd(column, value) {
+    containedBy(column, value) {
         if (typeof value === 'string') {
@@ -205,3 +224,3 @@ // range
      */
-    sl(column, range) {
+    rangeLt(column, range) {
         this.url.searchParams.append(`${column}`, `sl.${range}`);
@@ -217,3 +236,3 @@ return this;
      */
-    sr(column, range) {
+    rangeGt(column, range) {
         this.url.searchParams.append(`${column}`, `sr.${range}`);
@@ -229,3 +248,3 @@ return this;
      */
-    nxl(column, range) {
+    rangeGte(column, range) {
         this.url.searchParams.append(`${column}`, `nxl.${range}`);
@@ -241,3 +260,3 @@ return this;
      */
-    nxr(column, range) {
+    rangeLte(column, range) {
         this.url.searchParams.append(`${column}`, `nxr.${range}`);
@@ -253,3 +272,3 @@ return this;
      */
-    adj(column, range) {
+    rangeAdjacent(column, range) {
         this.url.searchParams.append(`${column}`, `adj.${range}`);
@@ -259,4 +278,4 @@ return this;
     /**
-     * Finds all rows whose array or range value on the stated `column` is
-     * contained by the specified `value`.
+     * Finds all rows whose array or range value on the stated `column` overlaps
+     * (has a value in common) with the specified `value`.
      *
@@ -266,3 +285,3 @@ * @param column  The column to filter on.
      */
-    ov(column, value) {
+    overlaps(column, value) {
         if (typeof value === 'string') {
@@ -279,2 +298,26 @@ // range
     /**
+     * Finds all rows whose text or tsvector value on the stated `column` matches
+     * the tsquery in `query`.
+     *
+     * @param column  The column to filter on.
+     * @param query  The Postgres tsquery string to filter with.
+     * @param config  The text search configuration to use.
+     * @param type  The type of tsquery conversion to use on `query`.
+     */
+    textSearch(column, query, { config, type = null, } = {}) {
+        let typePart = '';
+        if (type === 'plain') {
+            typePart = 'pl';
+        }
+        else if (type === 'phrase') {
+            typePart = 'ph';
+        }
+        else if (type === 'websearch') {
+            typePart = 'w';
+        }
+        const configPart = config === undefined ? '' : `(${config})`;
+        this.url.searchParams.append(`${column}`, `${typePart}fts${configPart}.${query}`);
+        return this;
+    }
+    /**
      * Finds all rows whose tsvector value on the stated `column` matches
@@ -286,2 +329,4 @@ * to_tsquery(`query`).
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` instead.
      */
@@ -300,2 +345,4 @@ fts(column, query, { config } = {}) {
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` with `type: 'plain'` instead.
      */
@@ -314,2 +361,4 @@ plfts(column, query, { config } = {}) {
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` with `type: 'phrase'` instead.
      */
@@ -328,2 +377,4 @@ phfts(column, query, { config } = {}) {
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` with `type: 'websearch'` instead.
      */
@@ -330,0 +381,0 @@ wfts(column, query, { config } = {}) {

dist/module/lib/PostgrestFilterBuilder.d.ts

@@ -111,3 +111,5 @@ import PostgrestTransformBuilder from './PostgrestTransformBuilder';
      */
-    cs(column: keyof T, value: string | T[keyof T][] | object): this;
+    contains(column: keyof T, value: string | T[keyof T][] | object): this;
+    /** @deprecated Use `contains()` instead. */
+    cs: (column: keyof T, value: string | T[keyof T][] | object) => this;
     /**
@@ -120,3 +122,5 @@ * Finds all rows whose json, array, or range value on the stated `column` is
      */
-    cd(column: keyof T, value: string | T[keyof T][] | object): this;
+    containedBy(column: keyof T, value: string | T[keyof T][] | object): this;
+    /** @deprecated Use `containedBy()` instead. */
+    cd: (column: keyof T, value: string | T[keyof T][] | object) => this;
     /**
@@ -129,3 +133,5 @@ * Finds all rows whose range value on the stated `column` is strictly to the
      */
-    sl(column: keyof T, range: string): this;
+    rangeLt(column: keyof T, range: string): this;
+    /** @deprecated Use `rangeLt()` instead. */
+    sl: (column: keyof T, range: string) => this;
     /**
@@ -138,3 +144,5 @@ * Finds all rows whose range value on the stated `column` is strictly to
      */
-    sr(column: keyof T, range: string): this;
+    rangeGt(column: keyof T, range: string): this;
+    /** @deprecated Use `rangeGt()` instead. */
+    sr: (column: keyof T, range: string) => this;
     /**
@@ -147,3 +155,5 @@ * Finds all rows whose range value on the stated `column` does not extend
      */
-    nxl(column: keyof T, range: string): this;
+    rangeGte(column: keyof T, range: string): this;
+    /** @deprecated Use `rangeGte()` instead. */
+    nxl: (column: keyof T, range: string) => this;
     /**
@@ -156,3 +166,5 @@ * Finds all rows whose range value on the stated `column` does not extend
      */
-    nxr(column: keyof T, range: string): this;
+    rangeLte(column: keyof T, range: string): this;
+    /** @deprecated Use `rangeLte()` instead. */
+    nxr: (column: keyof T, range: string) => this;
     /**
@@ -165,6 +177,8 @@ * Finds all rows whose range value on the stated `column` is adjacent to
      */
-    adj(column: keyof T, range: string): this;
+    rangeAdjacent(column: keyof T, range: string): this;
+    /** @deprecated Use `rangeAdjacent()` instead. */
+    adj: (column: keyof T, range: string) => this;
     /**
-     * Finds all rows whose array or range value on the stated `column` is
-     * contained by the specified `value`.
+     * Finds all rows whose array or range value on the stated `column` overlaps
+     * (has a value in common) with the specified `value`.
      *
@@ -174,4 +188,19 @@ * @param column  The column to filter on.
      */
-    ov(column: keyof T, value: string | T[keyof T][]): this;
+    overlaps(column: keyof T, value: string | T[keyof T][]): this;
+    /** @deprecated Use `overlaps()` instead. */
+    ov: (column: keyof T, value: string | T[keyof T][]) => this;
     /**
+     * Finds all rows whose text or tsvector value on the stated `column` matches
+     * the tsquery in `query`.
+     *
+     * @param column  The column to filter on.
+     * @param query  The Postgres tsquery string to filter with.
+     * @param config  The text search configuration to use.
+     * @param type  The type of tsquery conversion to use on `query`.
+     */
+    textSearch(column: keyof T, query: string, { config, type, }?: {
+        config?: string;
+        type?: 'plain' | 'phrase' | 'websearch' | null;
+    }): this;
+    /**
      * Finds all rows whose tsvector value on the stated `column` matches
@@ -183,2 +212,4 @@ * to_tsquery(`query`).
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` instead.
      */
@@ -195,2 +226,4 @@ fts(column: keyof T, query: string, { config }?: {
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` with `type: 'plain'` instead.
      */
@@ -207,2 +240,4 @@ plfts(column: keyof T, query: string, { config }?: {
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` with `type: 'phrase'` instead.
      */
@@ -219,2 +254,4 @@ phfts(column: keyof T, query: string, { config }?: {
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` with `type: 'websearch'` instead.
      */
@@ -221,0 +258,0 @@ wfts(column: keyof T, query: string, { config }?: {

dist/module/lib/PostgrestFilterBuilder.js

 import PostgrestTransformBuilder from './PostgrestTransformBuilder';
 export default class PostgrestFilterBuilder extends PostgrestTransformBuilder {
+    constructor() {
+        super(...arguments);
+        /** @deprecated Use `contains()` instead. */
+        this.cs = this.contains;
+        /** @deprecated Use `containedBy()` instead. */
+        this.cd = this.containedBy;
+        /** @deprecated Use `rangeLt()` instead. */
+        this.sl = this.rangeLt;
+        /** @deprecated Use `rangeGt()` instead. */
+        this.sr = this.rangeGt;
+        /** @deprecated Use `rangeGte()` instead. */
+        this.nxl = this.rangeGte;
+        /** @deprecated Use `rangeLte()` instead. */
+        this.nxr = this.rangeLte;
+        /** @deprecated Use `rangeAdjacent()` instead. */
+        this.adj = this.rangeAdjacent;
+        /** @deprecated Use `overlaps()` instead. */
+        this.ov = this.overlaps;
+    }
     /**
@@ -152,3 +171,3 @@ * Finds all rows which doesn't satisfy the filter.
      */
-    cs(column, value) {
+    contains(column, value) {
         if (typeof value === 'string') {
@@ -176,3 +195,3 @@ // range types can be inclusive '[', ']' or exclusive '(', ')' so just
      */
-    cd(column, value) {
+    containedBy(column, value) {
         if (typeof value === 'string') {
@@ -199,3 +218,3 @@ // range
      */
-    sl(column, range) {
+    rangeLt(column, range) {
         this.url.searchParams.append(`${column}`, `sl.${range}`);
@@ -211,3 +230,3 @@ return this;
      */
-    sr(column, range) {
+    rangeGt(column, range) {
         this.url.searchParams.append(`${column}`, `sr.${range}`);
@@ -223,3 +242,3 @@ return this;
      */
-    nxl(column, range) {
+    rangeGte(column, range) {
         this.url.searchParams.append(`${column}`, `nxl.${range}`);
@@ -235,3 +254,3 @@ return this;
      */
-    nxr(column, range) {
+    rangeLte(column, range) {
         this.url.searchParams.append(`${column}`, `nxr.${range}`);
@@ -247,3 +266,3 @@ return this;
      */
-    adj(column, range) {
+    rangeAdjacent(column, range) {
         this.url.searchParams.append(`${column}`, `adj.${range}`);
@@ -253,4 +272,4 @@ return this;
     /**
-     * Finds all rows whose array or range value on the stated `column` is
-     * contained by the specified `value`.
+     * Finds all rows whose array or range value on the stated `column` overlaps
+     * (has a value in common) with the specified `value`.
      *
@@ -260,3 +279,3 @@ * @param column  The column to filter on.
      */
-    ov(column, value) {
+    overlaps(column, value) {
         if (typeof value === 'string') {
@@ -273,2 +292,26 @@ // range
     /**
+     * Finds all rows whose text or tsvector value on the stated `column` matches
+     * the tsquery in `query`.
+     *
+     * @param column  The column to filter on.
+     * @param query  The Postgres tsquery string to filter with.
+     * @param config  The text search configuration to use.
+     * @param type  The type of tsquery conversion to use on `query`.
+     */
+    textSearch(column, query, { config, type = null, } = {}) {
+        let typePart = '';
+        if (type === 'plain') {
+            typePart = 'pl';
+        }
+        else if (type === 'phrase') {
+            typePart = 'ph';
+        }
+        else if (type === 'websearch') {
+            typePart = 'w';
+        }
+        const configPart = config === undefined ? '' : `(${config})`;
+        this.url.searchParams.append(`${column}`, `${typePart}fts${configPart}.${query}`);
+        return this;
+    }
+    /**
      * Finds all rows whose tsvector value on the stated `column` matches
@@ -280,2 +323,4 @@ * to_tsquery(`query`).
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` instead.
      */
@@ -294,2 +339,4 @@ fts(column, query, { config } = {}) {
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` with `type: 'plain'` instead.
      */
@@ -308,2 +355,4 @@ plfts(column, query, { config } = {}) {
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` with `type: 'phrase'` instead.
      */
@@ -322,2 +371,4 @@ phfts(column, query, { config } = {}) {
      * @param config  The text search configuration to use.
+     *
+     * @deprecated Use `textSearch()` with `type: 'websearch'` instead.
      */
@@ -324,0 +375,0 @@ wfts(column, query, { config } = {}) {

package.json

 {
   "name": "@supabase/postgrest-js",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "description": "Isomorphic PostgREST client",
@@ -5,0 +5,0 @@ "keywords": [

No alert changes

Improved metrics

Total package byte prevSize

153307

increased by7.87%

Lines of code

2493

increased by7.6%

No dependency changes