remult 3.4.0-next.9 → 3.4.0

package/src/data-api.d.ts

@@ -24,6 +24,10 @@ export declare class DataApi<T = unknown> {
     getArray(response: DataApiResponse, request: DataApiRequest, body?: any): Promise<void>;
     liveQuery(response: DataApiResponse, request: DataApiRequest, body: any, serializeContext: () => Promise<any>, queryChannel: string): Promise<void>;
     private buildWhere;
+    private fieldIsInApi;
+    private fieldsInApi;
+    private omitFieldsHiddenFromApi;
+    private handleError;
     private doOnId;
     updateManyThroughPutRequest(response: DataApiResponse, request: DataApiRequest, body: any): Promise<void>;
     updateManyImplementation(response: DataApiResponse, request: DataApiRequest, body: {

package/src/data-api.js

@@ -8,6 +8,7 @@ var context_js_1 = require("./context.js");
 var data_interfaces_js_1 = require("./data-interfaces.js");
 var rest_data_provider_js_1 = require("./data-providers/rest-data-provider.js");
 var filter_interfaces_js_1 = require("./filter/filter-interfaces.js");
+var walk_filter_js_1 = require("./filter/walk-filter.js");
 var relationInfoMember_js_1 = require("./remult3/relationInfoMember.js");
 var remult3_js_1 = require("./remult3/remult3.js");
 var server_action_js_1 = require("./server-action.js");
@@ -41,10 +42,7 @@ var DataApi = /** @class */ (function () {
                     case 4: return [2 /*return*/, this.getArray(res, req, undefined)];
                     case 5:
                         err_1 = _d.sent();
-                        if (err_1.isForbiddenError)
-                            res.forbidden(err_1.message);
-                        else
-                            res.error(err_1, this.repository.metadata);
+                        this.handleError(res, err_1);
                         return [3 /*break*/, 6];
                     case 6: return [2 /*return*/];
                 }
@@ -115,10 +113,7 @@ var DataApi = /** @class */ (function () {
                     case 14: return [3 /*break*/, 16];
                     case 15:
                         err_2 = _f.sent();
-                        if (err_2.isForbiddenError)
-                            res.forbidden(err_2.message);
-                        else
-                            res.error(err_2, this.repository.metadata);
+                        this.handleError(res, err_2);
                         return [3 /*break*/, 16];
                     case 16: return [2 /*return*/];
                 }
@@ -232,10 +227,7 @@ var DataApi = /** @class */ (function () {
                             })];
                     case 3:
                         err_3 = _c.sent();
-                        if (err_3.isForbiddenError)
-                            response.forbidden();
-                        else
-                            response.error(err_3, this.repository.metadata);
+                        this.handleError(response, err_3);
                         return [3 /*break*/, 4];
                     case 4: return [2 /*return*/];
                 }
@@ -287,7 +279,7 @@ var DataApi = /** @class */ (function () {
                         return [3 /*break*/, 5];
                     case 4:
                         err_4 = _f.sent();
-                        response.error(err_4, this.repository.metadata);
+                        this.handleError(response, err_4);
                         return [3 /*break*/, 5];
                     case 5: return [2 /*return*/];
                 }
@@ -359,7 +351,7 @@ var DataApi = /** @class */ (function () {
                     case 2: return [2 /*return*/, _a.sent()];
                     case 3:
                         err_5 = _a.sent();
-                        response.error(err_5, this.repository.metadata);
+                        this.handleError(response, err_5);
                         return [3 /*break*/, 4];
                     case 4: return [2 /*return*/];
                 }
@@ -389,16 +381,15 @@ var DataApi = /** @class */ (function () {
             var findOptions, orderBy, _a, _b, element, direction, group, min, max, result, minMax, _loop_1, _c, _d, element;
             var e_3, _e, _f, _g, e_4, _h;
             var _this = this;
-            var _j, _k, _l, _m, _o, _p, _q;
-            return tslib_1.__generator(this, function (_r) {
-                switch (_r.label) {
+            return tslib_1.__generator(this, function (_j) {
+                switch (_j.label) {
                     case 0:
                         if (!this.repository.metadata.apiReadAllowed) {
                             throw new server_action_js_1.ForbiddenError();
                         }
                         return [4 /*yield*/, this.findOptionsFromRequest(request, body)];
                     case 1:
-                        findOptions = _r.sent();
+                        findOptions = _j.sent();
                         orderBy = {};
                         if (body === null || body === void 0 ? void 0 : body.orderBy) {
                             try {
@@ -406,7 +397,7 @@ var DataApi = /** @class */ (function () {
                                     element = _b.value;
                                     direction = element.isDescending ? 'desc' : 'asc';
                                     if (element.operation !== 'count' &&
-                                        !((_j = this.repository.fields.find(element.field)) === null || _j === void 0 ? void 0 : _j.includedInApi()))
+                                        !this.fieldIsInApi(element.field))
                                         continue;
                                     switch (element.operation) {
                                         case undefined:
@@ -429,15 +420,9 @@ var DataApi = /** @class */ (function () {
                                 finally { if (e_3) throw e_3.error; }
                             }
                         }
-                        group = (_k = body === null || body === void 0 ? void 0 : body.groupBy) === null || _k === void 0 ? void 0 : _k.filter(function (x) {
-                            return _this.repository.fields.find(x).includedInApi();
-                        });
-                        min = (_l = body === null || body === void 0 ? void 0 : body.min) === null || _l === void 0 ? void 0 : _l.filter(function (x) {
-                            return _this.repository.fields.find(x).includedInApi();
-                        });
-                        max = (_m = body === null || body === void 0 ? void 0 : body.max) === null || _m === void 0 ? void 0 : _m.filter(function (x) {
-                            return _this.repository.fields.find(x).includedInApi();
-                        });
+                        group = this.fieldsInApi(body === null || body === void 0 ? void 0 : body.groupBy);
+                        min = this.fieldsInApi(body === null || body === void 0 ? void 0 : body.min);
+                        max = this.fieldsInApi(body === null || body === void 0 ? void 0 : body.max);
                         return [4 /*yield*/, this.repository.groupBy((_g = {
                                     where: findOptions.where,
                                     limit: findOptions.limit,
@@ -446,21 +431,15 @@ var DataApi = /** @class */ (function () {
                                 //@ts-expect-error internal key
                                 _g[remult3_js_1.GroupByForApiKey] = true,
                                 _g.group = group,
-                                _g.sum = (_o = body === null || body === void 0 ? void 0 : body.sum) === null || _o === void 0 ? void 0 : _o.filter(function (x) {
-                                    return _this.repository.fields.find(x).includedInApi();
-                                }),
-                                _g.avg = (_p = body === null || body === void 0 ? void 0 : body.avg) === null || _p === void 0 ? void 0 : _p.filter(function (x) {
-                                    return _this.repository.fields.find(x).includedInApi();
-                                }),
+                                _g.sum = this.fieldsInApi(body === null || body === void 0 ? void 0 : body.sum),
+                                _g.avg = this.fieldsInApi(body === null || body === void 0 ? void 0 : body.avg),
                                 _g.min = min,
                                 _g.max = max,
-                                _g.distinctCount = (_q = body === null || body === void 0 ? void 0 : body.distinctCount) === null || _q === void 0 ? void 0 : _q.filter(function (x) {
-                                    return _this.repository.fields.find(x).includedInApi();
-                                }),
+                                _g.distinctCount = this.fieldsInApi(body === null || body === void 0 ? void 0 : body.distinctCount),
                                 _g.orderBy = orderBy,
                                 _g))];
                     case 2:
-                        result = _r.sent();
+                        result = _j.sent();
                         if (group)
                             result.forEach(function (x) {
                                 var e_5, _a;
@@ -566,7 +545,7 @@ var DataApi = /** @class */ (function () {
                             sort = request.get('_sort');
                             if (sort != undefined) {
                                 dir = request.get('_order');
-                                findOptions.orderBy = determineSort(sort, dir);
+                                findOptions.orderBy = this.omitFieldsHiddenFromApi(determineSort(sort, dir));
                             }
                             limit = +request.get('_limit');
                             if (!limit && DataApi.defaultGetLimit)
@@ -664,10 +643,7 @@ var DataApi = /** @class */ (function () {
                         return [3 /*break*/, 4];
                     case 3:
                         err_6 = _a.sent();
-                        if (err_6.isForbiddenError)
-                            response.forbidden(err_6.message);
-                        else
-                            response.error(err_6, this.repository.metadata);
+                        this.handleError(response, err_6);
                         return [3 /*break*/, 4];
                     case 4: return [2 /*return*/];
                 }
@@ -711,10 +687,7 @@ var DataApi = /** @class */ (function () {
                         return [3 /*break*/, 6];
                     case 5:
                         err_7 = _b.sent();
-                        if (err_7.isForbiddenError)
-                            response.forbidden();
-                        else
-                            response.error(err_7, this.repository.metadata);
+                        this.handleError(response, err_7);
                         return [3 /*break*/, 6];
                     case 6: return [2 /*return*/];
                 }
@@ -755,6 +728,7 @@ var DataApi = /** @class */ (function () {
                                 return result;
                             },
                         });
+                        f_1 = this.omitFieldsHiddenFromApi(f_1);
                         if (!this.repository.metadata.options.apiPreprocessFilter) return [3 /*break*/, 5];
                         return [4 /*yield*/, this.repository.metadata.options.apiPreprocessFilter(f_1, {
                                 metadata: this.repository.metadata,
@@ -775,6 +749,35 @@ var DataApi = /** @class */ (function () {
             });
         });
     };
+    // A hidden field is not on the api, same as a field that is not on the entity.
+    DataApi.prototype.fieldIsInApi = function (key) {
+        var _a;
+        return ((_a = this.repository.fields.find(key)) === null || _a === void 0 ? void 0 : _a.includedInApi()) === true;
+    };
+    DataApi.prototype.fieldsInApi = function (keys) {
+        var _this = this;
+        return keys === null || keys === void 0 ? void 0 : keys.filter(function (key) {
+            return _this.fieldIsInApi(key);
+        });
+    };
+    // Drop a field the api hides. Same as a field that is not on the entity:
+    // refusing it would confirm the name exists.
+    DataApi.prototype.omitFieldsHiddenFromApi = function (filterOrSort) {
+        var fields = this.repository.metadata.fields;
+        return (0, walk_filter_js_1.walkFilter)(filterOrSort, function (key, value) {
+            var _a;
+            if (!key.startsWith(filter_interfaces_js_1.customUrlToken) &&
+                ((_a = fields.find(key)) === null || _a === void 0 ? void 0 : _a.includedInApi()) === false)
+                return walk_filter_js_1.omitFilterField;
+            return value;
+        });
+    };
+    DataApi.prototype.handleError = function (response, err) {
+        if (err.isForbiddenError)
+            response.forbidden(err.message);
+        else
+            response.error(err, this.repository.metadata);
+    };
     DataApi.prototype.doOnId = function (response, id, what) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
             var where, _a, _b, err_8;
@@ -917,7 +920,7 @@ var DataApi = /** @class */ (function () {
                     case 2: return [2 /*return*/, _a.sent()];
                     case 3:
                         err_9 = _a.sent();
-                        response.error(err_9, this.repository.metadata);
+                        this.handleError(response, err_9);
                         return [3 /*break*/, 4];
                     case 4: return [2 /*return*/];
                 }

package/src/data-providers/sql-database.d.ts

@@ -1,8 +1,8 @@
 import type { DataProvider, EntityDataProvider, EntityDataProviderGroupByOptions, EntityDataProviderFindOptions } from '../data-interfaces.js';
-import type { HasWrapIdentifier, SqlCommand, SqlCommandFactory, SqlCommandWithParameters, SqlImplementation, SqlResult } from '../sql-command.js';
+import type { HasJsonColumnStorage, HasWrapIdentifier, JsonColumnStorage, SqlCommand, SqlCommandFactory, SqlCommandWithParameters, SqlImplementation, SqlResult } from '../sql-command.js';
 import type { FieldMetadata } from '../column-interfaces.js';
 import type { CustomSqlFilterBuilderFunction, EntityDbNamesBase } from '../filter/filter-consumer-bridge-to-sql-request.js';
-import { type EntityFilter, type EntityMetadata, type FindOptions, type GroupByOptions, type GroupByResult, type MembersOnly, type NumericKeys } from '../remult3/remult3.js';
+import { type EntityFilter, type EntityMetadata, type FindOptions, type GroupByOptions, type GroupByResult, type MembersOnly, type NumericKeys, type Repository } from '../remult3/remult3.js';
 import type { RepositoryOverloads } from '../remult3/RepositoryImplementation.js';
 import type { CanBuildMigrations, MigrationBuilder, MigrationCode } from '../../migrations/migration-types.js';
 /**
@@ -12,7 +12,7 @@ import type { CanBuildMigrations, MigrationBuilder, MigrationCode } from '../../
 * @see [Connecting a Database](https://remult.dev/docs/quickstart#connecting-a-database)
 
  */
-export declare class SqlDatabase implements DataProvider, HasWrapIdentifier, CanBuildMigrations, SqlCommandFactory {
+export declare class SqlDatabase implements DataProvider, HasWrapIdentifier, HasJsonColumnStorage, CanBuildMigrations, SqlCommandFactory {
     private sql;
     /**
      * Gets the SQL database from the data provider.
@@ -38,6 +38,7 @@ export declare class SqlDatabase implements DataProvider, HasWrapIdentifier, Can
      * Wraps an identifier with the database's identifier syntax.
      */
     wrapIdentifier: (name: string) => string;
+    get jsonColumnStorage(): JsonColumnStorage;
     ensureSchema(entities: EntityMetadata[]): Promise<void>;
     /**
      * Gets the entity data provider.
@@ -121,20 +122,28 @@ export interface RawSelectOptions {
     wrapIdentifier?: (name: string) => string;
     /** Required only with `limit`: `(limit, offset) => 'limit 10 offset 20'`. */
     limitSyntax?: (limit: number, offset: number) => string;
+    /**
+     * JSON columns are stored as text (SQL Server, sqlite, mysql).
+     * Defaults to the repository's data provider.
+     * Set when `sqlCommand` runs against a different database than that provider.
+     */
+    jsonAsString?: boolean;
 }
+export declare function jsonColumnStorageOf(r: Repository<any>): JsonColumnStorage;
 export declare function getRowAfterUpdate<entityType>(meta: EntityMetadata<entityType>, dataProvider: EntityDataProvider, data: any, id: any, operation: string): any;
 /** The select that `find` runs, and the mapping of one result row to field values. With `aliasColumns`, every column is aliased through `wrapIdentifier`, so a row can be read by alias as well as by position. */
-export declare function buildFindSql(entity: EntityMetadata, options: EntityDataProviderFindOptions | undefined, e: EntityDbNamesBase, r: SqlCommandWithParameters, orderByNullsFirst: boolean | undefined, limitSyntax: (limit: number, offset: number) => string, { aliasColumns }?: {
-    aliasColumns?: boolean | undefined;
+export declare function buildFindSql(entity: EntityMetadata, options: EntityDataProviderFindOptions | undefined, e: EntityDbNamesBase, r: SqlCommandWithParameters, orderByNullsFirst: boolean | undefined, limitSyntax: (limit: number, offset: number) => string, { aliasColumns, jsonColumnStorage, }?: {
+    aliasColumns?: boolean;
+    jsonColumnStorage?: JsonColumnStorage;
 }): Promise<{
     select: string;
     colKeys: FieldMetadata<unknown, unknown>[];
     /** `valueAt` reads one column of a result row, by its position in the select or by its alias (the field key). */
     toResult(valueAt: (indexInSelect: number, alias: string) => any): any;
 }>;
-export declare function groupByImpl(options: EntityDataProviderGroupByOptions | undefined, e: EntityDbNamesBase, r: SqlCommand, orderByNullFirst: boolean | undefined, limitSyntax: (limit: number, offset: number) => string): Promise<any[]>;
+export declare function groupByImpl(options: EntityDataProviderGroupByOptions | undefined, e: EntityDbNamesBase, r: SqlCommand, orderByNullFirst: boolean | undefined, limitSyntax: (limit: number, offset: number) => string, jsonColumnStorage?: JsonColumnStorage): Promise<any[]>;
 /** The select that `groupBy` runs, and the mapping of one result row back to a `GroupByResult`. Every column is aliased through `wrapIdentifier`, so a row can be read by alias as well as by position. */
-export declare function buildGroupBySql(options: EntityDataProviderGroupByOptions | undefined, e: EntityDbNamesBase, r: SqlCommandWithParameters, orderByNullFirst: boolean | undefined, limitSyntax: (limit: number, offset: number) => string): Promise<{
+export declare function buildGroupBySql(options: EntityDataProviderGroupByOptions | undefined, e: EntityDbNamesBase, r: SqlCommandWithParameters, orderByNullFirst: boolean | undefined, limitSyntax: (limit: number, offset: number) => string, jsonColumnStorage?: JsonColumnStorage): Promise<{
     select: string;
     /** `valueAt` reads one column of a result row, by its position in the select or by its alias. */
     toResult(valueAt: (indexInSelect: number, alias: string) => any): any;