@supabase/postgrest-js 3.0.0-next.21 → 3.0.0-next.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supabase/postgrest-js",
-  "version": "3.0.0-next.21",
+  "version": "3.0.0-next.22",
   "description": "Isomorphic PostgREST client",
   "keywords": [
     "postgrest",

package/src/PostgrestBuilder.ts

@@ -168,6 +168,7 @@ export default abstract class PostgrestBuilder<
    * {@link https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls}
    *
    * @category Database
+   * @subcategory Using modifiers
    *
    * @example With `select()`
    * ```ts
@@ -589,6 +590,7 @@ export default abstract class PostgrestBuilder<
    * @returns A PostgrestBuilder instance with the new type
    *
    * @category Database
+   * @subcategory Using modifiers
    *
    * @example Complete Override type of successful response
    * ```ts
@@ -644,7 +646,7 @@ export default abstract class PostgrestBuilder<
    * let x: typeof data // CountryRowProperties & { status: "A" | "B" } | null
    * ```
    *
-   * @example Example 5
+   * @example Merge vs replace existing types
    * ```typescript
    * // Merge with existing types (default behavior)
    * const query = supabase

package/src/PostgrestFilterBuilder.ts

@@ -118,6 +118,7 @@ export default class PostgrestFilterBuilder<
    * @param value - The value to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @example With `select()`
    * ```ts
@@ -179,6 +180,7 @@ export default class PostgrestFilterBuilder<
    * @param value - The value to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @example With `select()`
    * ```ts
@@ -246,6 +248,7 @@ export default class PostgrestFilterBuilder<
    * @param value - The value to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @exampleDescription With `select()`
    * When using [reserved words](https://www.postgresql.org/docs/current/sql-keywords-appendix.html) for column names you need
@@ -300,6 +303,7 @@ export default class PostgrestFilterBuilder<
    * @param value - The value to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @example With `select()`
    * ```ts
@@ -354,6 +358,7 @@ export default class PostgrestFilterBuilder<
    * @param value - The value to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @example With `select()`
    * ```ts
@@ -404,6 +409,7 @@ export default class PostgrestFilterBuilder<
    * @param value - The value to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @example With `select()`
    * ```ts
@@ -458,6 +464,7 @@ export default class PostgrestFilterBuilder<
    * @param pattern - The pattern to match with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @example With `select()`
    * ```ts
@@ -511,6 +518,7 @@ export default class PostgrestFilterBuilder<
    * @param patterns - The patterns to match with
    *
    * @category Database
+   * @subcategory Using filters
    */
   likeAllOf(column: string, patterns: readonly string[]): this {
     this.url.searchParams.append(column, `like(all).{${patterns.join(',')}}`)
@@ -529,6 +537,7 @@ export default class PostgrestFilterBuilder<
    * @param patterns - The patterns to match with
    *
    * @category Database
+   * @subcategory Using filters
    */
   likeAnyOf(column: string, patterns: readonly string[]): this {
     this.url.searchParams.append(column, `like(any).{${patterns.join(',')}}`)
@@ -544,6 +553,7 @@ export default class PostgrestFilterBuilder<
    * @param pattern - The pattern to match with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @example With `select()`
    * ```ts
@@ -597,6 +607,7 @@ export default class PostgrestFilterBuilder<
    * @param patterns - The patterns to match with
    *
    * @category Database
+   * @subcategory Using filters
    */
   ilikeAllOf(column: string, patterns: readonly string[]): this {
     this.url.searchParams.append(column, `ilike(all).{${patterns.join(',')}}`)
@@ -615,6 +626,7 @@ export default class PostgrestFilterBuilder<
    * @param patterns - The patterns to match with
    *
    * @category Database
+   * @subcategory Using filters
    */
   ilikeAnyOf(column: string, patterns: readonly string[]): this {
     this.url.searchParams.append(column, `ilike(any).{${patterns.join(',')}}`)
@@ -667,6 +679,7 @@ export default class PostgrestFilterBuilder<
    * @param value - The value to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @exampleDescription Checking for nullness, true or false
    * Using the `eq()` filter doesn't work when filtering for `null`.
@@ -741,6 +754,7 @@ export default class PostgrestFilterBuilder<
    * @param values - The values array to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @example With `select()`
    * ```ts
@@ -847,6 +861,7 @@ export default class PostgrestFilterBuilder<
    * @param value - The jsonb, array, or range value to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @example On array columns
    * ```ts
@@ -995,6 +1010,7 @@ export default class PostgrestFilterBuilder<
    * @param value - The jsonb, array, or range value to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @example On array columns
    * ```ts
@@ -1140,6 +1156,7 @@ export default class PostgrestFilterBuilder<
    * @param range - The range to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @exampleDescription With `select()`
    * Postgres supports a number of [range
@@ -1203,6 +1220,7 @@ export default class PostgrestFilterBuilder<
    * @param range - The range to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @exampleDescription With `select()`
    * Postgres supports a number of [range
@@ -1265,6 +1283,7 @@ export default class PostgrestFilterBuilder<
    * @param range - The range to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @exampleDescription With `select()`
    * Postgres supports a number of [range
@@ -1327,6 +1346,7 @@ export default class PostgrestFilterBuilder<
    * @param range - The range to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @exampleDescription With `select()`
    * Postgres supports a number of [range
@@ -1390,6 +1410,7 @@ export default class PostgrestFilterBuilder<
    * @param range - The range to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @exampleDescription With `select()`
    * Postgres supports a number of [range
@@ -1454,6 +1475,7 @@ export default class PostgrestFilterBuilder<
    * @param value - The array or range value to filter with
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @example On array columns
    * ```ts
@@ -1569,6 +1591,7 @@ export default class PostgrestFilterBuilder<
    * @param options.type - Change how the `query` text is interpreted
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @remarks
    * - For more information, see [Postgres full text search](/docs/guides/database/full-text-search).
@@ -1689,6 +1712,7 @@ export default class PostgrestFilterBuilder<
    * to their filter values
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @example With `select()`
    * ```ts
@@ -1769,6 +1793,7 @@ export default class PostgrestFilterBuilder<
    * @param value - The value to filter with, following PostgREST syntax
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @remarks
    * not() expects you to use the raw PostgREST syntax for the filter values.
@@ -1839,6 +1864,7 @@ export default class PostgrestFilterBuilder<
    * @param options.foreignTable - Deprecated, use `referencedTable` instead
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @remarks
    * or() expects you to use the raw PostgREST syntax for the filter names and values.
@@ -2005,6 +2031,7 @@ export default class PostgrestFilterBuilder<
    * @param value - The value to filter with, following PostgREST syntax
    *
    * @category Database
+   * @subcategory Using filters
    *
    * @remarks
    * filter() expects you to use the raw PostgREST syntax for the filter values.

package/src/PostgrestTransformBuilder.ts

@@ -24,6 +24,7 @@ export default class PostgrestTransformBuilder<
    * @param columns - The columns to retrieve, separated by commas
    *
    * @category Database
+   * @subcategory Using modifiers
    *
    * @example With `upsert()`
    * ```ts
@@ -148,6 +149,7 @@ export default class PostgrestTransformBuilder<
    * instead
    *
    * @category Database
+   * @subcategory Using modifiers
    *
    * @example With `select()`
    * ```ts
@@ -354,6 +356,7 @@ export default class PostgrestTransformBuilder<
    * instead
    *
    * @category Database
+   * @subcategory Using modifiers
    *
    * @example With `select()`
    * ```ts
@@ -470,6 +473,7 @@ export default class PostgrestTransformBuilder<
    * instead
    *
    * @category Database
+   * @subcategory Using modifiers
    *
    * @example With `select()`
    * ```ts
@@ -531,6 +535,7 @@ export default class PostgrestTransformBuilder<
    * @param signal - The AbortSignal to use for the fetch request
    *
    * @category Database
+   * @subcategory Using modifiers
    *
    * @remarks
    * You can use this to set a timeout for the request.
@@ -602,6 +607,7 @@ export default class PostgrestTransformBuilder<
    * returns an error.
    *
    * @category Database
+   * @subcategory Using modifiers
    *
    * @example With `select()`
    * ```ts
@@ -651,6 +657,7 @@ export default class PostgrestTransformBuilder<
    * this returns an error.
    *
    * @category Database
+   * @subcategory Using modifiers
    *
    * @example With `select()`
    * ```ts
@@ -695,6 +702,7 @@ export default class PostgrestTransformBuilder<
    * Return `data` as a string in CSV format.
    *
    * @category Database
+   * @subcategory Using modifiers
    *
    * @exampleDescription Return data as CSV
    * By default, the data is returned in JSON format, but can also be returned as Comma Separated Values.
@@ -770,6 +778,7 @@ export default class PostgrestTransformBuilder<
    * or `"json"`
    *
    * @category Database
+   * @subcategory Using modifiers
    *
    * @exampleDescription Get the execution plan
    * By default, the data is returned in TEXT format, but can also be returned as JSON by using the `format` parameter.
@@ -895,6 +904,7 @@ export default class PostgrestTransformBuilder<
    * @deprecated Use overrideTypes<yourType, { merge: false }>() method at the end of your call chain instead
    *
    * @category Database
+   * @subcategory Using modifiers
    *
    * @remarks
    * - Deprecated: use overrideTypes method instead

package/src/version.ts

@@ -4,4 +4,4 @@
 // - Debugging and support (identifying which version is running)
 // - Telemetry and logging (version reporting in errors/analytics)
 // - Ensuring build artifacts match the published package version
-export const version = '3.0.0-next.21'
+export const version = '3.0.0-next.22'