skapi-js 2.2.2 → 2.2.4

package/dist/skapi.d.mts

@@ -573,6 +573,7 @@ type RequestHistory = {
     created: number;
     updated: number;
     executed?: number;
+    responded?: number;
     request_body: any;
     expires?: number;
     status: 'pending' | 'running' | 'resolved' | 'failed';
@@ -1360,6 +1361,12 @@ declare class Skapi {
     /**
      * Queries unique ID records by unique_id or condition filters.
      *
+     * With `condition` omitted the unique ID is matched exactly. `gte` / `>=`
+     * is a prefix search ("unique IDs starting with x") and `lte` / `<=` is a
+     * suffix search ("unique IDs ending with x"); `gt` / `>` and `lt` / `<`
+     * are lexicographic. An 'ends with' search returns its matches in the
+     * order of the unique ID read from its last character backwards.
+     *
      * Refused to a signed out caller when the project's `require_login`
      * setting is on: REQUIRE_LOGIN from the SDK, INVALID_REQUEST from the
      * backend for a caller that skips it. A project that has never set the
@@ -1378,7 +1385,7 @@ declare class Skapi {
     getUniqueId(params?: Form<{
         /** Unique ID */
         unique_id?: string;
-        /** String query condition for the unique_id value. */
+        /** String query condition for the unique_id value. Omitted: exact match. `gte` / `>=`: starts with. `lte` / `<=`: ends with. */
         condition?: Condition | 'ne' | '!=';
     }>, fetchOptions?: FetchOptions): Promise<DatabaseResponse<UniqueId>>;
     /**
@@ -2201,13 +2208,17 @@ declare class Skapi {
      * exactly. With `table` omitted entirely, every table is returned.
      * `gte` / `>=` is a prefix search ("table names starting with x"), while
      * `gt` / `>` is a lexicographic greater-than that spills past the prefix
-     * into every later table name.
+     * into every later table name. `lte` / `<=` is a suffix search ("table
+     * names ending with x"); its matches come back in the order of the name
+     * read from its last character backwards.
      *
      * Every combination:
      * - `getTables({})`: every table in the project.
      * - `getTables({ table: 'x' })`: exact match on 'x'.
      * - `getTables({ table: 'x', condition: 'gte' })`: prefix, every table
      *   name starting with 'x'.
+     * - `getTables({ table: 'x', condition: 'lte' })`: suffix, every table
+     *   name ending with 'x'.
      * - `getTables({ table: '' })`: errors with '"table" should not be empty.'
      * - `getTables({ condition: 'gte' })` with no `table`: errors with
      *   '"table" is required for condition.'
@@ -2250,7 +2261,7 @@ declare class Skapi {
     /** If omitted, fetches the full list of tables. */
     query?: {
         table?: string;
-        /** Condition operator of table name. Omitted: exact match on the given table name. `gte` / `>=`: prefix. */
+        /** Condition operator of table name. Omitted: exact match on the given table name. `gte` / `>=`: starts with. `lte` / `<=`: ends with. */
         condition?: Condition;
     }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<Table>>;
     /**
@@ -2265,6 +2276,14 @@ declare class Skapi {
      * The only condition is `order.condition`, which requires `order.value`.
      * Omitting it matches `order.value` exactly.
      *
+     * With `order.by: 'index_name'`, `order.value` is a piece of the name and
+     * the condition searches the names: `>=` 'starts with', `<=` 'ends with',
+     * `>` and `<` the names after and before it in order. 'Ends with' matches
+     * the name segment right under `index` (or the first segment when `index`
+     * is omitted), and returns what is nested under a match as well, the way
+     * 'starts with' does: `index: 'Band.'` with `value: 'ers'` and `<=` finds
+     * Band.Members, Band.Members.name and Band.Singers.
+     *
      * Every combination (`table` is required, so there is no no-argument
      * form):
      * - `getIndexes({ table: 't' })`: every index of table 't'.
@@ -2274,6 +2293,12 @@ declare class Skapi {
      *   the compound index, so Band.name, Band.year.
      * - `getIndexes({ table: 't', order: { by: 'index_name', value: 'B' } })`:
      *   exact match against the value.
+     * - `getIndexes({ table: 't', order: { by: 'index_name' } })`: every index
+     *   of the table, ordered by name.
+     * - `getIndexes({ table: 't', order: { by: 'index_name', value: 'B', condition: '>=' } })`:
+     *   the index names that start with 'B'.
+     * - `getIndexes({ table: 't', order: { by: 'index_name', value: 'e', condition: '<=' } })`:
+     *   the index names that end with 'e'.
      * - `getIndexes({ table: 't', order: { by: 'total_number' } })`: the whole
      *   partition, ordered by that attribute.
      * - `order.condition` without `order.value`: errors.
@@ -2315,9 +2340,9 @@ declare class Skapi {
         order?: {
             /** Key name to order by. */
             by: 'average_number' | 'total_number' | 'number_count' | 'average_bool' | 'total_bool' | 'bool_count' | 'string_count' | 'index_name' | 'number_of_records';
-            /** Value to query. */
+            /** Value to query. A string when "by" is 'index_name': a piece of the index name. */
             value?: number | boolean | string;
-            /** Requires "value". Omitted: exact match against "value". */
+            /** Requires "value". Omitted: exact match against "value". With "by" 'index_name': `>=` starts with, `<=` ends with. */
             condition?: Condition;
         };
     }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<Index>>;
@@ -2328,7 +2353,9 @@ declare class Skapi {
      * `table` and `tag` together match the tag exactly, `table` alone is a
      * prefix ('>=') that lists every tag in that table, and neither one
      * returns every tag in the project, ordered by record count, descending.
-     * `gte` / `>=` is a prefix search.
+     * `gte` / `>=` is a prefix search and `lte` / `<=` is a suffix search:
+     * with `table` it finds the tags of that table that end with `tag`, and
+     * with `tag` alone the tags that end with it in every table.
      *
      * Every combination:
      * - `getTags({})`: every tag in the project, ordered by record count,
@@ -2340,6 +2367,10 @@ declare class Skapi {
      *   tables.
      * - `getTags({ table: 't', tag: 'g', condition: 'gte' })`: prefix, every
      *   tag in 't' starting with 'g'.
+     * - `getTags({ table: 't', tag: 'g', condition: 'lte' })`: suffix, every
+     *   tag in 't' ending with 'g'.
+     * - `getTags({ tag: 'g', condition: 'lte' })` with no `table`: every tag
+     *   ending with 'g', in every table.
      * - `getTags({ condition: 'gte' })` with neither `table` nor `tag`: errors
      *   with '"table" or "tag" is required for condition.'
      *
@@ -2376,7 +2407,7 @@ declare class Skapi {
         table?: string;
         /** Tag name */
         tag?: string;
-        /** String query condition for tag name. Omitted: exact match when `table` and `tag` are both given, prefix when only `table` is given. */
+        /** String query condition for tag name. Omitted: exact match when `table` and `tag` are both given, prefix when only `table` is given. `gte` / `>=`: starts with. `lte` / `<=`: ends with. */
         condition?: Condition;
     }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<Tag>>;
     /**
@@ -2779,11 +2810,16 @@ declare class Skapi {
          */
         signup_confirmation?: boolean | string;
         /**
-         * When true, user will be subscribed to Service Email (group 1) once they are signed up.
-         * User's signup confirmation is required for this parameter.
+         * The newsletter the user is subscribed to once they confirm their e-mail, with no
+         * newsletter confirmation e-mail of its own.
+         * `0` or `'public'`: the public newsletter. `1` or `'authorized'`: Service Email.
+         * The name of a named newsletter group: that group, which has to exist and whose
+         * restriction the account has to meet. `true`: Service Email, as before.
+         * User's signup confirmation is required for this parameter: a user whose e-mail is
+         * never confirmed is never subscribed.
          * Default is false.
          */
-        email_subscription?: boolean;
+        email_subscription?: boolean | number | string;
         /**
          * Automatically login to account after signup. Will not work if signup confirmation is required.
          */

package/dist/skapi.d.ts

@@ -573,6 +573,7 @@ type RequestHistory = {
     created: number;
     updated: number;
     executed?: number;
+    responded?: number;
     request_body: any;
     expires?: number;
     status: 'pending' | 'running' | 'resolved' | 'failed';
@@ -1360,6 +1361,12 @@ declare class Skapi {
     /**
      * Queries unique ID records by unique_id or condition filters.
      *
+     * With `condition` omitted the unique ID is matched exactly. `gte` / `>=`
+     * is a prefix search ("unique IDs starting with x") and `lte` / `<=` is a
+     * suffix search ("unique IDs ending with x"); `gt` / `>` and `lt` / `<`
+     * are lexicographic. An 'ends with' search returns its matches in the
+     * order of the unique ID read from its last character backwards.
+     *
      * Refused to a signed out caller when the project's `require_login`
      * setting is on: REQUIRE_LOGIN from the SDK, INVALID_REQUEST from the
      * backend for a caller that skips it. A project that has never set the
@@ -1378,7 +1385,7 @@ declare class Skapi {
     getUniqueId(params?: Form<{
         /** Unique ID */
         unique_id?: string;
-        /** String query condition for the unique_id value. */
+        /** String query condition for the unique_id value. Omitted: exact match. `gte` / `>=`: starts with. `lte` / `<=`: ends with. */
         condition?: Condition | 'ne' | '!=';
     }>, fetchOptions?: FetchOptions): Promise<DatabaseResponse<UniqueId>>;
     /**
@@ -2201,13 +2208,17 @@ declare class Skapi {
      * exactly. With `table` omitted entirely, every table is returned.
      * `gte` / `>=` is a prefix search ("table names starting with x"), while
      * `gt` / `>` is a lexicographic greater-than that spills past the prefix
-     * into every later table name.
+     * into every later table name. `lte` / `<=` is a suffix search ("table
+     * names ending with x"); its matches come back in the order of the name
+     * read from its last character backwards.
      *
      * Every combination:
      * - `getTables({})`: every table in the project.
      * - `getTables({ table: 'x' })`: exact match on 'x'.
      * - `getTables({ table: 'x', condition: 'gte' })`: prefix, every table
      *   name starting with 'x'.
+     * - `getTables({ table: 'x', condition: 'lte' })`: suffix, every table
+     *   name ending with 'x'.
      * - `getTables({ table: '' })`: errors with '"table" should not be empty.'
      * - `getTables({ condition: 'gte' })` with no `table`: errors with
      *   '"table" is required for condition.'
@@ -2250,7 +2261,7 @@ declare class Skapi {
     /** If omitted, fetches the full list of tables. */
     query?: {
         table?: string;
-        /** Condition operator of table name. Omitted: exact match on the given table name. `gte` / `>=`: prefix. */
+        /** Condition operator of table name. Omitted: exact match on the given table name. `gte` / `>=`: starts with. `lte` / `<=`: ends with. */
         condition?: Condition;
     }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<Table>>;
     /**
@@ -2265,6 +2276,14 @@ declare class Skapi {
      * The only condition is `order.condition`, which requires `order.value`.
      * Omitting it matches `order.value` exactly.
      *
+     * With `order.by: 'index_name'`, `order.value` is a piece of the name and
+     * the condition searches the names: `>=` 'starts with', `<=` 'ends with',
+     * `>` and `<` the names after and before it in order. 'Ends with' matches
+     * the name segment right under `index` (or the first segment when `index`
+     * is omitted), and returns what is nested under a match as well, the way
+     * 'starts with' does: `index: 'Band.'` with `value: 'ers'` and `<=` finds
+     * Band.Members, Band.Members.name and Band.Singers.
+     *
      * Every combination (`table` is required, so there is no no-argument
      * form):
      * - `getIndexes({ table: 't' })`: every index of table 't'.
@@ -2274,6 +2293,12 @@ declare class Skapi {
      *   the compound index, so Band.name, Band.year.
      * - `getIndexes({ table: 't', order: { by: 'index_name', value: 'B' } })`:
      *   exact match against the value.
+     * - `getIndexes({ table: 't', order: { by: 'index_name' } })`: every index
+     *   of the table, ordered by name.
+     * - `getIndexes({ table: 't', order: { by: 'index_name', value: 'B', condition: '>=' } })`:
+     *   the index names that start with 'B'.
+     * - `getIndexes({ table: 't', order: { by: 'index_name', value: 'e', condition: '<=' } })`:
+     *   the index names that end with 'e'.
      * - `getIndexes({ table: 't', order: { by: 'total_number' } })`: the whole
      *   partition, ordered by that attribute.
      * - `order.condition` without `order.value`: errors.
@@ -2315,9 +2340,9 @@ declare class Skapi {
         order?: {
             /** Key name to order by. */
             by: 'average_number' | 'total_number' | 'number_count' | 'average_bool' | 'total_bool' | 'bool_count' | 'string_count' | 'index_name' | 'number_of_records';
-            /** Value to query. */
+            /** Value to query. A string when "by" is 'index_name': a piece of the index name. */
             value?: number | boolean | string;
-            /** Requires "value". Omitted: exact match against "value". */
+            /** Requires "value". Omitted: exact match against "value". With "by" 'index_name': `>=` starts with, `<=` ends with. */
             condition?: Condition;
         };
     }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<Index>>;
@@ -2328,7 +2353,9 @@ declare class Skapi {
      * `table` and `tag` together match the tag exactly, `table` alone is a
      * prefix ('>=') that lists every tag in that table, and neither one
      * returns every tag in the project, ordered by record count, descending.
-     * `gte` / `>=` is a prefix search.
+     * `gte` / `>=` is a prefix search and `lte` / `<=` is a suffix search:
+     * with `table` it finds the tags of that table that end with `tag`, and
+     * with `tag` alone the tags that end with it in every table.
      *
      * Every combination:
      * - `getTags({})`: every tag in the project, ordered by record count,
@@ -2340,6 +2367,10 @@ declare class Skapi {
      *   tables.
      * - `getTags({ table: 't', tag: 'g', condition: 'gte' })`: prefix, every
      *   tag in 't' starting with 'g'.
+     * - `getTags({ table: 't', tag: 'g', condition: 'lte' })`: suffix, every
+     *   tag in 't' ending with 'g'.
+     * - `getTags({ tag: 'g', condition: 'lte' })` with no `table`: every tag
+     *   ending with 'g', in every table.
      * - `getTags({ condition: 'gte' })` with neither `table` nor `tag`: errors
      *   with '"table" or "tag" is required for condition.'
      *
@@ -2376,7 +2407,7 @@ declare class Skapi {
         table?: string;
         /** Tag name */
         tag?: string;
-        /** String query condition for tag name. Omitted: exact match when `table` and `tag` are both given, prefix when only `table` is given. */
+        /** String query condition for tag name. Omitted: exact match when `table` and `tag` are both given, prefix when only `table` is given. `gte` / `>=`: starts with. `lte` / `<=`: ends with. */
         condition?: Condition;
     }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<Tag>>;
     /**
@@ -2779,11 +2810,16 @@ declare class Skapi {
          */
         signup_confirmation?: boolean | string;
         /**
-         * When true, user will be subscribed to Service Email (group 1) once they are signed up.
-         * User's signup confirmation is required for this parameter.
+         * The newsletter the user is subscribed to once they confirm their e-mail, with no
+         * newsletter confirmation e-mail of its own.
+         * `0` or `'public'`: the public newsletter. `1` or `'authorized'`: Service Email.
+         * The name of a named newsletter group: that group, which has to exist and whose
+         * restriction the account has to meet. `true`: Service Email, as before.
+         * User's signup confirmation is required for this parameter: a user whose e-mail is
+         * never confirmed is never subscribed.
          * Default is false.
          */
-        email_subscription?: boolean;
+        email_subscription?: boolean | number | string;
         /**
          * Automatically login to account after signup. Will not work if signup confirmation is required.
          */