remult 0.25.8-exp.1 → 0.25.8-exp.2

package/esm/migrations/generate-migrations.js

@@ -5,6 +5,18 @@ import { updateMigrationsFile } from './update-migrations-ts-file.js';
 import { DefaultMigrationBuilder, } from './migration-types.js';
 import { isOfType } from '../src/isOfType.js';
 import { initDataProvider } from '../server/initDataProvider.js';
+/**
+ * Generates migration scripts based on changes in entities.
+ *
+ * @param options - Configuration options for generating migrations.
+ * @param options.entities - An array of entity classes to be included in the migration.
+ * @param options.dataProvider - The data provider instance or a function returning a promise of the data provider.
+ * @param options.migrationsFolder - (Optional) The path to the folder where migration scripts will be stored. Default is 'src/server/migrations'.
+ * @param options.snapshotFile - (Optional) The path to the file where the snapshot of the last known state will be stored. Default is 'migrations-snapshot.json' in the `migrationsFolder`.
+ * @param options.migrationsTSFile - (Optional) The path to the TypeScript file where the generated migrations will be written. Default is 'migrations.ts' in the `migrationsFolder`.
+ * @param options.endConnection - (Optional) Determines whether to close the database connection after generating migrations. Default is true.
+ * @see [Migrations](http://remult.dev/docs/migrations.html)
+ */
 export async function generateMigrations(options) {
     const migrationDir = options.migrationsFolder ||
         path.join(process.cwd(), 'src/server/migrations');

package/esm/migrations/migrate.js

@@ -3,6 +3,16 @@ import { Entity, IdEntity, Fields, remult, Remult, } from '../index.js';
 import { initDataProvider } from '../server/initDataProvider.js';
 import { doTransaction } from '../src/context.js';
 import { cast, isOfType } from '../src/isOfType.js';
+/**
+ * Applies migration scripts to update the database schema.
+ *
+ * @param options - Configuration options for applying migrations.
+ * @param options.migrations - An object containing the migration scripts, each keyed by a unique identifier.
+ * @param options.dataProvider - The data provider instance or a function returning a promise of the data provider.
+ * @param options.migrationsTable - (Optional) The name of the table that tracks applied migrations. Default is '__remult_migrations_version'.
+ * @param options.endConnection - (Optional) Determines whether to close the database connection after applying migrations. Default is true.
+* @see [Migrations](http://remult.dev/docs/migrations.html)
+*/
 export async function migrate(options) {
     let migrationTableName = options.migrationsTable || '__remult_migrations_version';
     const dataProvider = await initDataProvider(options.dataProvider);

package/esm/postgres/postgres-data-provider.js

@@ -8,8 +8,8 @@ export class PostgresDataProvider {
     pool;
     options;
     supportsJsonColumnType = true;
-    static getDb(remult) {
-        const r = (remult || defaultRemult).dataProvider;
+    static getDb(dataProvider) {
+        const r = (dataProvider || defaultRemult.dataProvider);
         if (!r._getSourceSql)
             throw 'the data provider is not an SqlDatabase';
         const me = r._getSourceSql();

package/esm/remult-knex/index.js

@@ -41,8 +41,8 @@ export class KnexDataProvider {
     execute(sql) {
         return this.createCommand().execute(sql);
     }
-    static getDb(remult) {
-        const r = (remult || remultContext).dataProvider;
+    static getDb(dataProvider) {
+        const r = (dataProvider || remultContext.dataProvider);
         if (!r.knex)
             throw 'the data provider is not an KnexDataProvider';
         return r.knex;

package/esm/remult-mongo.js

@@ -16,8 +16,8 @@ export class MongoDataProvider {
     }
     session;
     disableTransactions = false;
-    static getDb(remult) {
-        const r = (remult || remultContext).dataProvider;
+    static getDb(dataProvider) {
+        const r = (dataProvider || remultContext.dataProvider);
         if (!r.db)
             throw 'the data provider is not a MongoDataProvider';
         return { db: r.db, session: r.session };

package/esm/server/expressBridge.js

@@ -13,6 +13,7 @@ import { serverActionField } from '../src/server-action-info.js';
 import { initDataProvider } from './initDataProvider.js';
 import { remultStatic } from '../src/remult-static.js';
 import remultAdminHtml from './remult-admin.js';
+import { isOfType } from '../src/isOfType.js';
 export function createRemultServerCore(options, serverCoreOptions) {
     if (!options) {
         options = {};
@@ -285,7 +286,7 @@ export class RemultServerImplementation {
                     genReq.params = req['_tempParams'];
             }
             let myReq = new ExpressRequestBridgeToDataApiRequest(genReq);
-            let myRes = new ExpressResponseBridgeToDataApiResponse(origRes, req);
+            let myRes = new ExpressResponseBridgeToDataApiResponse(origRes, req, this.options.error);
             try {
                 await this.runWithRemult(async (remult) => {
                     if (req) {
@@ -315,7 +316,7 @@ export class RemultServerImplementation {
                 });
             }
             catch (err) {
-                myRes.error(serializeError(err));
+                myRes.error(err, undefined);
             }
         };
     }
@@ -673,15 +674,17 @@ class ExpressRequestBridgeToDataApiRequest {
 class ExpressResponseBridgeToDataApiResponse {
     r;
     req;
+    handleError;
     forbidden() {
-        this.setStatus(403).end();
+        this.error({ message: 'Forbidden' }, undefined, 403);
     }
     setStatus(status) {
         return this.r.status(status);
     }
-    constructor(r, req) {
+    constructor(r, req, handleError) {
         this.r = r;
         this.req = req;
+        this.handleError = handleError;
     }
     progress(progress) { }
     success(data) {
@@ -694,22 +697,53 @@ class ExpressResponseBridgeToDataApiResponse {
         this.setStatus(204).end();
     }
     notFound() {
-        this.setStatus(404).end();
+        this.error({ message: 'Forbidden' }, undefined, 404);
     }
-    error(data) {
-        data = serializeError(data);
-        console.error({
-            message: data.message,
-            stack: data.stack?.split('\n'),
-            url: this.req?.url,
-            method: this.req?.method,
+    async error(exception, entity, httpStatusCode) {
+        let data = serializeError(exception);
+        if (!httpStatusCode) {
+            if (data.httpStatusCode) {
+                httpStatusCode = data.httpStatusCode;
+            }
+            else if (isOfType(exception, 'isForbiddenError') &&
+                exception.isForbiddenError) {
+                httpStatusCode = 403;
+            }
+            else if (data.modelState) {
+                httpStatusCode = 400;
+            }
+            else {
+                httpStatusCode = 500;
+            }
+        }
+        let responseSent = false;
+        const sendError = (httpStatusCode, body) => {
+            if (responseSent) {
+                throw Error('Error response already sent');
+            }
+            responseSent = true;
+            console.error({
+                message: body.message,
+                httpStatusCode,
+                stack: data.stack?.split('\n'),
+                url: this.req?.url,
+                method: this.req?.method,
+            });
+            this.setStatus(httpStatusCode).json(body);
+        };
+        await this.handleError?.({
+            httpStatusCode,
+            req: this.req,
+            entity,
+            exception,
+            responseBody: data,
+            sendError,
         });
-        this.setStatus(400).json(data);
+        if (!responseSent) {
+            sendError(httpStatusCode, data);
+        }
     }
 }
-function throwError() {
-    throw 'Invalid';
-}
 class inProcessQueueHandler {
     storage;
     constructor(storage) {

package/esm/src/data-api.js

@@ -61,7 +61,7 @@ export class DataApi {
             });
         }
         catch (err) {
-            response.error(err);
+            response.error(err, this.repository.metadata);
         }
     }
     async deleteMany(response, request, filterBody) {
@@ -79,7 +79,7 @@ export class DataApi {
             });
         }
         catch (err) {
-            response.error(err);
+            response.error(err, this.repository.metadata);
         }
     }
     async getArrayImpl(response, request, filterBody) {
@@ -159,7 +159,7 @@ export class DataApi {
             if (err.isForbiddenError)
                 response.forbidden();
             else
-                response.error(err);
+                response.error(err, this.repository.metadata);
         }
     }
     async liveQuery(response, request, filterBody, serializeContext, queryChannel) {
@@ -185,7 +185,7 @@ export class DataApi {
             if (err.isForbiddenError)
                 response.forbidden();
             else
-                response.error(err);
+                response.error(err, this.repository.metadata);
         }
     }
     async buildWhere(request, filterBody) {
@@ -232,13 +232,16 @@ export class DataApi {
                 if (r.length == 0)
                     response.notFound();
                 else if (r.length > 1)
-                    response.error({ message: 'id is not unique' });
+                    response.error({
+                        message: `id "${id}" is not unique for entity ` +
+                            this.repository.metadata.key,
+                    }, this.repository.metadata, 500);
                 else
                     await what(r[0]);
             });
         }
         catch (err) {
-            response.error(err);
+            response.error(err, this.repository.metadata);
         }
     }
     async updateMany(response, request, body) {
@@ -256,7 +259,7 @@ export class DataApi {
             });
         }
         catch (err) {
-            response.error(err);
+            response.error(err, this.repository.metadata);
         }
     }
     async actualUpdate(row, body) {
@@ -313,7 +316,7 @@ export class DataApi {
             if (err.isForbiddenError)
                 response.forbidden();
             else
-                response.error(err);
+                response.error(err, this.repository.metadata);
         }
     }
 }

package/esm/src/data-providers/sql-database.js

@@ -10,8 +10,8 @@ import { isOfType } from '../isOfType.js';
 // @dynamic
 export class SqlDatabase {
     sql;
-    static getDb(remult) {
-        const r = (remult || defaultRemult).dataProvider;
+    static getDb(dataProvider) {
+        const r = (dataProvider || defaultRemult.dataProvider);
         if (isOfType(r, 'createCommand'))
             return r;
         else

package/esm/src/remult3/remult3.js

@@ -1,33 +1,17 @@
 export {};
-//p1 - migrations - in docs empesize that mysql doesn't support transactions in ddl, in docs empesize destroy for knex - // await dataProvider.knex.destroy()
-//https://gitkraken.dev/link/dnNjb2RlOi8vZWFtb2Rpby5naXRsZW5zL2xpbmsvci9mMDgzMWU0OWIyODJkMDlkNTA0NTcxYjYwNmUzNTMwODQ3NGIwY2M2L2YvcHJvamVjdHMvcGxheS13aXRoLW1pZ3JhdGlvbnMvc3JjL3NlcnZlci9idWlsZC1taWdyYXRpb25zLnRzP3VybD1odHRwcyUzQSUyRiUyRmdpdGh1Yi5jb20lMkZyZW11bHQlMkZyZW11bHQuZ2l0?origin=gitlens
-/*p1 - processError in remult express
-- Should we merge (notFound,error,forbidden) into one method in `DataApiResponse` type?
-https://gitkraken.dev/link/dnNjb2RlOi8vZWFtb2Rpby5naXRsZW5zL2xpbmsvci9mMDgzMWU0OWIyODJkMDlkNTA0NTcxYjYwNmUzNTMwODQ3NGIwY2M2L2YvcHJvamVjdHMvY29yZS9zcmMvZGF0YS1hcGkudHM%2FdXJsPWh0dHBzJTNBJTJGJTJGZ2l0aHViLmNvbSUyRnJlbXVsdCUyRnJlbXVsdC5naXQ%3D?origin=gitlens
-- The api of the `processError` should recieve an `ErrorInfo` object and return an `ErrorInfo` object? or should it return something more in the line,
-of httpStatus and errorBody. - currently the `serializeError` method is used to build the response
-https://gitkraken.dev/link/dnNjb2RlOi8vZWFtb2Rpby5naXRsZW5zL2xpbmsvci9mMDgzMWU0OWIyODJkMDlkNTA0NTcxYjYwNmUzNTMwODQ3NGIwY2M2L2YvcHJvamVjdHMvY29yZS9zcmMvZGF0YS1hcGkudHM%2FdXJsPWh0dHBzJTNBJTJGJTJGZ2l0aHViLmNvbSUyRnJlbXVsdCUyRnJlbXVsdC5naXQmbGluZXM9NDI1?origin=gitlens
-- I think there should be a way to throw a forbidden exception
-*/
-//p1 - cleanup root directory of reult
 //p1 - in this video I'll use remult to turn a frontend app to a fullstack app
 /*p1 - discuss using delete & put - with url query language for deleteMany and updateMany -
-  - put & delete, similar to get
-  - add where to count, deleteMany,updateMany,
-  - prevent delete all and update all - must have meaningful where.
-    - try forcing this also in typescript
-
-  - protect against deleting of all rows by mistake
-  - https://github.com/remult/remult/issues/221#issuecomment-2016519746
-
-*/
-/*p1 -  I want to change the signature of getDb from getting optional remult, to getting optional dataProvider.
+- put & delete, similar to get
+- add where to count, deleteMany,updateMany,
+- prevent delete all and update all - must have meaningful where.
+- try forcing this also in typescript
 
-In most cases you will not send anything - and it'll be by default remult.dataProvider.
+- protect against deleting of all rows by mistake
+- https://github.com/remult/remult/issues/221#issuecomment-2016519746
 
-I just findmyself creating remults to extract the data provider :)
 */
 //y1 - getFields didn't work for kobi in the home component
+//p1 - document offline support
 //p1 - add section to Fields doc, explaining field type in db
 //p1 - add section about union type
 //p1 - add section about value list field type

package/esm/src/server-action.js

@@ -65,7 +65,7 @@ export class Action {
                     // got a problem in next with instance of ForbiddenError  - so replaced it with this bool
                     res.forbidden();
                 else
-                    res.error(err);
+                    res.error(err, undefined);
             }
         });
     }
@@ -245,7 +245,7 @@ export function BackendMethod(options) {
                                 // got a problem in next with instance of ForbiddenError  - so replaced it with this bool
                                 res.forbidden();
                             else
-                                res.error(err);
+                                res.error(err, undefined);
                         }
                     });
                 }

package/migrations/generate-migrations.d.ts

@@ -1,4 +1,16 @@
 import type { DataProvider } from '../index.js';
+/**
+ * Generates migration scripts based on changes in entities.
+ *
+ * @param options - Configuration options for generating migrations.
+ * @param options.entities - An array of entity classes to be included in the migration.
+ * @param options.dataProvider - The data provider instance or a function returning a promise of the data provider.
+ * @param options.migrationsFolder - (Optional) The path to the folder where migration scripts will be stored. Default is 'src/server/migrations'.
+ * @param options.snapshotFile - (Optional) The path to the file where the snapshot of the last known state will be stored. Default is 'migrations-snapshot.json' in the `migrationsFolder`.
+ * @param options.migrationsTSFile - (Optional) The path to the TypeScript file where the generated migrations will be written. Default is 'migrations.ts' in the `migrationsFolder`.
+ * @param options.endConnection - (Optional) Determines whether to close the database connection after generating migrations. Default is true.
+ * @see [Migrations](http://remult.dev/docs/migrations.html)
+ */
 export declare function generateMigrations(options: {
     entities: any[];
     dataProvider: DataProvider | Promise<DataProvider> | (() => Promise<DataProvider | undefined>);

package/migrations/generate-migrations.js

@@ -9,6 +9,18 @@ var update_migrations_ts_file_js_1 = require("./update-migrations-ts-file.js");
 var migration_types_js_1 = require("./migration-types.js");
 var isOfType_js_1 = require("../src/isOfType.js");
 var initDataProvider_js_1 = require("../server/initDataProvider.js");
+/**
+ * Generates migration scripts based on changes in entities.
+ *
+ * @param options - Configuration options for generating migrations.
+ * @param options.entities - An array of entity classes to be included in the migration.
+ * @param options.dataProvider - The data provider instance or a function returning a promise of the data provider.
+ * @param options.migrationsFolder - (Optional) The path to the folder where migration scripts will be stored. Default is 'src/server/migrations'.
+ * @param options.snapshotFile - (Optional) The path to the file where the snapshot of the last known state will be stored. Default is 'migrations-snapshot.json' in the `migrationsFolder`.
+ * @param options.migrationsTSFile - (Optional) The path to the TypeScript file where the generated migrations will be written. Default is 'migrations.ts' in the `migrationsFolder`.
+ * @param options.endConnection - (Optional) Determines whether to close the database connection after generating migrations. Default is true.
+ * @see [Migrations](http://remult.dev/docs/migrations.html)
+ */
 function generateMigrations(options) {
     return tslib_1.__awaiter(this, void 0, void 0, function () {
         var migrationDir, snapshotFileName, migrationsTSFilename, dataProvider, _a, _b, p, snapshot, hasSql, steps, code, migrationBuilder;

package/migrations/migrate.d.ts

@@ -1,5 +1,15 @@
 import { type DataProvider } from '../index.js';
 import type { Migrations } from './migration-types.js';
+/**
+ * Applies migration scripts to update the database schema.
+ *
+ * @param options - Configuration options for applying migrations.
+ * @param options.migrations - An object containing the migration scripts, each keyed by a unique identifier.
+ * @param options.dataProvider - The data provider instance or a function returning a promise of the data provider.
+ * @param options.migrationsTable - (Optional) The name of the table that tracks applied migrations. Default is '__remult_migrations_version'.
+ * @param options.endConnection - (Optional) Determines whether to close the database connection after applying migrations. Default is true.
+* @see [Migrations](http://remult.dev/docs/migrations.html)
+*/
 export declare function migrate(options: {
     migrations: Migrations;
     dataProvider: DataProvider | Promise<DataProvider> | (() => Promise<DataProvider | undefined>);

package/migrations/migrate.js

@@ -6,6 +6,16 @@ var index_js_1 = require("../index.js");
 var initDataProvider_js_1 = require("../server/initDataProvider.js");
 var context_js_1 = require("../src/context.js");
 var isOfType_js_1 = require("../src/isOfType.js");
+/**
+ * Applies migration scripts to update the database schema.
+ *
+ * @param options - Configuration options for applying migrations.
+ * @param options.migrations - An object containing the migration scripts, each keyed by a unique identifier.
+ * @param options.dataProvider - The data provider instance or a function returning a promise of the data provider.
+ * @param options.migrationsTable - (Optional) The name of the table that tracks applied migrations. Default is '__remult_migrations_version'.
+ * @param options.endConnection - (Optional) Determines whether to close the database connection after applying migrations. Default is true.
+* @see [Migrations](http://remult.dev/docs/migrations.html)
+*/
 function migrate(options) {
     return tslib_1.__awaiter(this, void 0, void 0, function () {
         var migrationTableName, dataProvider, prev, VersionInfo, repo, v, steps, _loop_1, steps_1, steps_1_1, _a, stepText, action, e_1_1;

package/migrations/migration-types.d.ts

@@ -11,6 +11,26 @@ export interface MigrationCode {
     addComment(comment: string): void;
     addTypescriptCode(code: string): void;
 }
+/**
+ * Represents a set of migrations, each identified by a unique number.
+ *
+ * Each migration function takes a `MigrationUtils` object as a parameter, which provides utility methods for executing SQL statements and other migration-related operations.
+ *
+ * Migrations are executed in a transaction, meaning that all changes within a single migration are either fully applied or fully rolled back in case of an error. This ensures the consistency of the database state.
+ *
+ * Note: Some databases, like MySQL, do not support rolling back structural changes (e.g., table creation or alteration) as part of a transaction. Developers should be aware of this when designing migrations for such databases.
+ *
+ * @example
+ * export const migrations: Migrations = {
+ *   1: async ({ sql }) => {
+ *     await sql(`CREATE TABLE example (id SERIAL PRIMARY KEY, name VARCHAR(255))`);
+ *   },
+ *   2: async ({ sql }) => {
+ *     await sql(`ALTER TABLE example ADD COLUMN description TEXT`);
+ *   },
+ * };
+ * @see [Migrations](http://remult.dev/docs/migrations.html)
+ */
 export type Migrations = Record<number, (utils: MigrationUtils) => Promise<unknown>>;
 export type MigrationUtils = {
     sql(sql: string): Promise<unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "0.25.8-exp.1",
+    "version": "0.25.8-exp.2",
     "description": "A CRUD framework for full-stack TypeScript",
     "homepage": "https://remult.dev",
     "repository": {

package/postgres/postgres-data-provider.d.ts

@@ -1,9 +1,9 @@
 import type { ClientBase, PoolConfig, QueryResult } from 'pg';
-import { Remult } from '../src/context.js';
 import { SqlDatabase } from '../src/data-providers/sql-database.js';
 import type { EntityMetadata } from '../src/remult3/remult3.js';
 import type { SqlCommand, SqlImplementation } from '../src/sql-command.js';
 import type { CanBuildMigrations, MigrationBuilder, MigrationCode } from '../migrations/migration-types.js';
+import type { DataProvider } from '../index.js';
 export interface PostgresPool extends PostgresCommandSource {
     connect(): Promise<PostgresClient>;
     end(): Promise<void>;
@@ -15,7 +15,7 @@ export declare class PostgresDataProvider implements SqlImplementation, CanBuild
     private pool;
     private options?;
     supportsJsonColumnType: boolean;
-    static getDb(remult?: Remult): ClientBase;
+    static getDb(dataProvider?: DataProvider): ClientBase;
     entityIsUsedForTheFirstTime(entity: EntityMetadata): Promise<void>;
     getLimitSqlSyntax(limit: number, offset: number): string;
     createCommand(): SqlCommand;

package/postgres/postgres-data-provider.js

@@ -31,8 +31,8 @@ var PostgresDataProvider = /** @class */ (function () {
             this.pool = new PostgresSchemaWrapper(pool, options.schema);
         }
     }
-    PostgresDataProvider.getDb = function (remult) {
-        var r = (remult || remult_proxy_js_1.remult).dataProvider;
+    PostgresDataProvider.getDb = function (dataProvider) {
+        var r = (dataProvider || remult_proxy_js_1.remult.dataProvider);
         if (!r._getSourceSql)
             throw 'the data provider is not an SqlDatabase';
         var me = r._getSourceSql();

package/remult-knex/index.d.ts

@@ -13,7 +13,7 @@ export declare class KnexDataProvider implements DataProvider, HasWrapIdentifier
     end(): Promise<void>;
     createCommand(): SqlCommand;
     execute(sql: string): Promise<SqlResult>;
-    static getDb(remult?: Remult): Knex<any, any[]>;
+    static getDb(dataProvider?: DataProvider): Knex<any, any[]>;
     wrapIdentifier: (name: string) => string;
     getEntityDataProvider(entity: EntityMetadata<any>): EntityDataProvider;
     transaction(action: (dataProvider: DataProvider) => Promise<void>): Promise<void>;

package/remult-knex/index.js

@@ -68,8 +68,8 @@ var KnexDataProvider = /** @class */ (function () {
     KnexDataProvider.prototype.execute = function (sql) {
         return this.createCommand().execute(sql);
     };
-    KnexDataProvider.getDb = function (remult) {
-        var r = (remult || remult_proxy_js_1.remult).dataProvider;
+    KnexDataProvider.getDb = function (dataProvider) {
+        var r = (dataProvider || remult_proxy_js_1.remult.dataProvider);
         if (!r.knex)
             throw 'the data provider is not an KnexDataProvider';
         return r.knex;

package/remult-mongo.d.ts

@@ -1,5 +1,5 @@
 import { type ClientSession, type Db, type MongoClient } from 'mongodb';
-import type { DataProvider, EntityDataProvider, EntityFilter, EntityMetadata, Remult } from './index.js';
+import type { DataProvider, EntityDataProvider, EntityFilter, EntityMetadata } from './index.js';
 import type { RepositoryOverloads } from './src/remult3/RepositoryImplementation.js';
 export declare class MongoDataProvider implements DataProvider {
     private db;
@@ -10,7 +10,7 @@ export declare class MongoDataProvider implements DataProvider {
     });
     session?: ClientSession;
     disableTransactions: boolean;
-    static getDb(remult?: Remult): {
+    static getDb(dataProvider?: DataProvider): {
         db: Db;
         session: ClientSession;
     };

package/remult-mongo.js

@@ -17,8 +17,8 @@ var MongoDataProvider = /** @class */ (function () {
         this.session = options === null || options === void 0 ? void 0 : options.session;
         this.disableTransactions = Boolean(options === null || options === void 0 ? void 0 : options.disableTransactions);
     }
-    MongoDataProvider.getDb = function (remult) {
-        var r = (remult || remult_proxy_js_1.remult).dataProvider;
+    MongoDataProvider.getDb = function (dataProvider) {
+        var r = (dataProvider || remult_proxy_js_1.remult.dataProvider);
         if (!r.db)
             throw 'the data provider is not a MongoDataProvider';
         return { db: r.db, session: r.session };

package/server/expressBridge.d.ts

@@ -55,6 +55,27 @@ export interface RemultServerOptions<RequestType> {
     admin?: Allowed;
     /** Storage to use for backend methods that use queue */
     queueStorage?: QueueStorage;
+    /**
+     * This method is called whenever there is an error in the API lifecycle.
+     *
+     * @param info - Information about the error.
+     * @param info.req - The request object.
+     * @param info.entity - (Optional) The entity metadata associated with the error, if applicable.
+     * @param info.exception - (Optional) The exception object or error that occurred.
+     * @param info.httpStatusCode - The HTTP status code.
+     * @param info.responseBody - The body of the response.
+     * @param info.sendError - A method to send a custom error response. Call this method with the desired HTTP status code and response body.
+     *
+     * @returns A promise that resolves when the error handling is complete.
+     * @example
+     * export const api = remultExpress({
+     *   error: async (e) => {
+     *     if (e.httpStatusCode == 500) {
+     *       e.sendError(500, { message: "An error occurred" })
+     *     }
+     *   }
+     * })
+     */
     error?: (info: {
         req: RequestType;
         entity?: EntityMetadata;

package/server/expressBridge.js

@@ -16,6 +16,7 @@ var server_action_info_js_1 = require("../src/server-action-info.js");
 var initDataProvider_js_1 = require("./initDataProvider.js");
 var remult_static_js_1 = require("../src/remult-static.js");
 var remult_admin_js_1 = tslib_1.__importDefault(require("./remult-admin.js"));
+var isOfType_js_1 = require("../src/isOfType.js");
 function createRemultServerCore(options, serverCoreOptions) {
     if (!options) {
         options = {};
@@ -543,7 +544,7 @@ var RemultServerImplementation = /** @class */ (function () {
                                 genReq.params = req['_tempParams'];
                         }
                         myReq = new ExpressRequestBridgeToDataApiRequest(genReq);
-                        myRes = new ExpressResponseBridgeToDataApiResponse(origRes, req);
+                        myRes = new ExpressResponseBridgeToDataApiResponse(origRes, req, this.options.error);
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 3, , 4]);
@@ -592,7 +593,7 @@ var RemultServerImplementation = /** @class */ (function () {
                         return [3 /*break*/, 4];
                     case 3:
                         err_1 = _a.sent();
-                        myRes.error((0, data_api_js_1.serializeError)(err_1));
+                        myRes.error(err_1, undefined);
                         return [3 /*break*/, 4];
                     case 4: return [2 /*return*/];
                 }
@@ -1001,12 +1002,13 @@ var ExpressRequestBridgeToDataApiRequest = /** @class */ (function () {
     return ExpressRequestBridgeToDataApiRequest;
 }());
 var ExpressResponseBridgeToDataApiResponse = /** @class */ (function () {
-    function ExpressResponseBridgeToDataApiResponse(r, req) {
+    function ExpressResponseBridgeToDataApiResponse(r, req, handleError) {
         this.r = r;
         this.req = req;
+        this.handleError = handleError;
     }
     ExpressResponseBridgeToDataApiResponse.prototype.forbidden = function () {
-        this.setStatus(403).end();
+        this.error({ message: 'Forbidden' }, undefined, 403);
     };
     ExpressResponseBridgeToDataApiResponse.prototype.setStatus = function (status) {
         return this.r.status(status);
@@ -1022,24 +1024,68 @@ var ExpressResponseBridgeToDataApiResponse = /** @class */ (function () {
         this.setStatus(204).end();
     };
     ExpressResponseBridgeToDataApiResponse.prototype.notFound = function () {
-        this.setStatus(404).end();
+        this.error({ message: 'Forbidden' }, undefined, 404);
     };
-    ExpressResponseBridgeToDataApiResponse.prototype.error = function (data) {
-        var _a, _b, _c;
-        data = (0, data_api_js_1.serializeError)(data);
-        console.error({
-            message: data.message,
-            stack: (_a = data.stack) === null || _a === void 0 ? void 0 : _a.split('\n'),
-            url: (_b = this.req) === null || _b === void 0 ? void 0 : _b.url,
-            method: (_c = this.req) === null || _c === void 0 ? void 0 : _c.method,
+    ExpressResponseBridgeToDataApiResponse.prototype.error = function (exception, entity, httpStatusCode) {
+        var _a;
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var data, responseSent, sendError;
+            var _this = this;
+            return tslib_1.__generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        data = (0, data_api_js_1.serializeError)(exception);
+                        if (!httpStatusCode) {
+                            if (data.httpStatusCode) {
+                                httpStatusCode = data.httpStatusCode;
+                            }
+                            else if ((0, isOfType_js_1.isOfType)(exception, 'isForbiddenError') &&
+                                exception.isForbiddenError) {
+                                httpStatusCode = 403;
+                            }
+                            else if (data.modelState) {
+                                httpStatusCode = 400;
+                            }
+                            else {
+                                httpStatusCode = 500;
+                            }
+                        }
+                        responseSent = false;
+                        sendError = function (httpStatusCode, body) {
+                            var _a, _b, _c;
+                            if (responseSent) {
+                                throw Error('Error response already sent');
+                            }
+                            responseSent = true;
+                            console.error({
+                                message: body.message,
+                                httpStatusCode: httpStatusCode,
+                                stack: (_a = data.stack) === null || _a === void 0 ? void 0 : _a.split('\n'),
+                                url: (_b = _this.req) === null || _b === void 0 ? void 0 : _b.url,
+                                method: (_c = _this.req) === null || _c === void 0 ? void 0 : _c.method,
+                            });
+                            _this.setStatus(httpStatusCode).json(body);
+                        };
+                        return [4 /*yield*/, ((_a = this.handleError) === null || _a === void 0 ? void 0 : _a.call(this, {
+                                httpStatusCode: httpStatusCode,
+                                req: this.req,
+                                entity: entity,
+                                exception: exception,
+                                responseBody: data,
+                                sendError: sendError,
+                            }))];
+                    case 1:
+                        _b.sent();
+                        if (!responseSent) {
+                            sendError(httpStatusCode, data);
+                        }
+                        return [2 /*return*/];
+                }
+            });
         });
-        this.setStatus(400).json(data);
     };
     return ExpressResponseBridgeToDataApiResponse;
 }());
-function throwError() {
-    throw 'Invalid';
-}
 var inProcessQueueHandler = /** @class */ (function () {
     function inProcessQueueHandler(storage) {
         this.storage = storage;

package/src/data-api.d.ts

@@ -1,6 +1,6 @@
 import type { Remult } from './context.js';
 import type { ErrorInfo } from './data-interfaces.js';
-import type { FindOptions, Repository } from './remult3/remult3.js';
+import type { EntityMetadata, FindOptions, Repository } from './remult3/remult3.js';
 import type { rowHelperImplementation } from './remult3/RepositoryImplementation.js';
 export declare class DataApi<T = any> {
     private repository;
@@ -33,7 +33,7 @@ export interface DataApiResponse {
     deleted(): void;
     created(data: any): void;
     notFound(): void;
-    error(data: ErrorInfo): void;
+    error(data: ErrorInfo, entity: EntityMetadata | undefined, statusCode?: number | undefined): void;
     forbidden(): void;
     progress(progress: number): void;
 }

package/src/data-api.js

@@ -100,7 +100,7 @@ var DataApi = /** @class */ (function () {
                         return [3 /*break*/, 5];
                     case 4:
                         err_1 = _f.sent();
-                        response.error(err_1);
+                        response.error(err_1, this.repository.metadata);
                         return [3 /*break*/, 5];
                     case 5: return [2 /*return*/];
                 }
@@ -175,7 +175,7 @@ var DataApi = /** @class */ (function () {
                     case 1: return [2 /*return*/, _a.sent()];
                     case 2:
                         err_2 = _a.sent();
-                        response.error(err_2);
+                        response.error(err_2, this.repository.metadata);
                         return [3 /*break*/, 3];
                     case 3: return [2 /*return*/];
                 }
@@ -304,7 +304,7 @@ var DataApi = /** @class */ (function () {
                         if (err_3.isForbiddenError)
                             response.forbidden();
                         else
-                            response.error(err_3);
+                            response.error(err_3, this.repository.metadata);
                         return [3 /*break*/, 4];
                     case 4: return [2 /*return*/];
                 }
@@ -350,7 +350,7 @@ var DataApi = /** @class */ (function () {
                         if (err_4.isForbiddenError)
                             response.forbidden();
                         else
-                            response.error(err_4);
+                            response.error(err_4, this.repository.metadata);
                         return [3 /*break*/, 6];
                     case 6: return [2 /*return*/];
                 }
@@ -429,7 +429,10 @@ var DataApi = /** @class */ (function () {
                                         return [3 /*break*/, 4];
                                     case 1:
                                         if (!(r.length > 1)) return [3 /*break*/, 2];
-                                        response.error({ message: 'id is not unique' });
+                                        response.error({
+                                            message: "id \"".concat(id, "\" is not unique for entity ") +
+                                                this.repository.metadata.key,
+                                        }, this.repository.metadata, 500);
                                         return [3 /*break*/, 4];
                                     case 2: return [4 /*yield*/, what(r[0])];
                                     case 3:
@@ -444,7 +447,7 @@ var DataApi = /** @class */ (function () {
                         return [3 /*break*/, 6];
                     case 5:
                         err_5 = _c.sent();
-                        response.error(err_5);
+                        response.error(err_5, this.repository.metadata);
                         return [3 /*break*/, 6];
                     case 6: return [2 /*return*/];
                 }
@@ -519,7 +522,7 @@ var DataApi = /** @class */ (function () {
                     case 1: return [2 /*return*/, _a.sent()];
                     case 2:
                         err_6 = _a.sent();
-                        response.error(err_6);
+                        response.error(err_6, this.repository.metadata);
                         return [3 /*break*/, 3];
                     case 3: return [2 /*return*/];
                 }
@@ -690,7 +693,7 @@ var DataApi = /** @class */ (function () {
                         if (err_7.isForbiddenError)
                             response.forbidden();
                         else
-                            response.error(err_7);
+                            response.error(err_7, this.repository.metadata);
                         return [3 /*break*/, 6];
                     case 6: return [2 /*return*/];
                 }

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

@@ -1,13 +1,12 @@
 import type { DataProvider, EntityDataProvider } from '../data-interfaces.js';
 import type { HasWrapIdentifier, SqlCommand, SqlCommandFactory, SqlCommandWithParameters, SqlImplementation, SqlResult } from '../sql-command.js';
-import type { Remult } from '../context.js';
 import type { CustomSqlFilterBuilderFunction, EntityDbNamesBase } from '../filter/filter-consumer-bridge-to-sql-request.js';
 import type { EntityFilter, EntityMetadata } from '../remult3/remult3.js';
 import type { RepositoryOverloads } from '../remult3/RepositoryImplementation.js';
 import type { CanBuildMigrations } from '../../migrations/migration-types.js';
 export declare class SqlDatabase implements DataProvider, HasWrapIdentifier, CanBuildMigrations, SqlCommandFactory {
     private sql;
-    static getDb(remult?: Remult): SqlDatabase;
+    static getDb(dataProvider?: DataProvider): SqlDatabase;
     createCommand(): SqlCommand;
     execute(sql: string): Promise<SqlResult>;
     wrapIdentifier: (name: string) => string;

package/src/data-providers/sql-database.js

@@ -25,8 +25,8 @@ var SqlDatabase = /** @class */ (function () {
         if ((0, isOfType_js_1.isOfType)(sql, 'end'))
             this.end = function () { return sql.end(); };
     }
-    SqlDatabase.getDb = function (remult) {
-        var r = (remult || remult_proxy_js_1.remult).dataProvider;
+    SqlDatabase.getDb = function (dataProvider) {
+        var r = (dataProvider || remult_proxy_js_1.remult.dataProvider);
         if ((0, isOfType_js_1.isOfType)(r, 'createCommand'))
             return r;
         else

package/src/remult3/remult3.js

@@ -1,34 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//p1 - migrations - in docs empesize that mysql doesn't support transactions in ddl, in docs empesize destroy for knex - // await dataProvider.knex.destroy()
-//https://gitkraken.dev/link/dnNjb2RlOi8vZWFtb2Rpby5naXRsZW5zL2xpbmsvci9mMDgzMWU0OWIyODJkMDlkNTA0NTcxYjYwNmUzNTMwODQ3NGIwY2M2L2YvcHJvamVjdHMvcGxheS13aXRoLW1pZ3JhdGlvbnMvc3JjL3NlcnZlci9idWlsZC1taWdyYXRpb25zLnRzP3VybD1odHRwcyUzQSUyRiUyRmdpdGh1Yi5jb20lMkZyZW11bHQlMkZyZW11bHQuZ2l0?origin=gitlens
-/*p1 - processError in remult express
-- Should we merge (notFound,error,forbidden) into one method in `DataApiResponse` type?
-https://gitkraken.dev/link/dnNjb2RlOi8vZWFtb2Rpby5naXRsZW5zL2xpbmsvci9mMDgzMWU0OWIyODJkMDlkNTA0NTcxYjYwNmUzNTMwODQ3NGIwY2M2L2YvcHJvamVjdHMvY29yZS9zcmMvZGF0YS1hcGkudHM%2FdXJsPWh0dHBzJTNBJTJGJTJGZ2l0aHViLmNvbSUyRnJlbXVsdCUyRnJlbXVsdC5naXQ%3D?origin=gitlens
-- The api of the `processError` should recieve an `ErrorInfo` object and return an `ErrorInfo` object? or should it return something more in the line,
-of httpStatus and errorBody. - currently the `serializeError` method is used to build the response
-https://gitkraken.dev/link/dnNjb2RlOi8vZWFtb2Rpby5naXRsZW5zL2xpbmsvci9mMDgzMWU0OWIyODJkMDlkNTA0NTcxYjYwNmUzNTMwODQ3NGIwY2M2L2YvcHJvamVjdHMvY29yZS9zcmMvZGF0YS1hcGkudHM%2FdXJsPWh0dHBzJTNBJTJGJTJGZ2l0aHViLmNvbSUyRnJlbXVsdCUyRnJlbXVsdC5naXQmbGluZXM9NDI1?origin=gitlens
-- I think there should be a way to throw a forbidden exception
-*/
-//p1 - cleanup root directory of reult
 //p1 - in this video I'll use remult to turn a frontend app to a fullstack app
 /*p1 - discuss using delete & put - with url query language for deleteMany and updateMany -
-  - put & delete, similar to get
-  - add where to count, deleteMany,updateMany,
-  - prevent delete all and update all - must have meaningful where.
-    - try forcing this also in typescript
-
-  - protect against deleting of all rows by mistake
-  - https://github.com/remult/remult/issues/221#issuecomment-2016519746
-
-*/
-/*p1 -  I want to change the signature of getDb from getting optional remult, to getting optional dataProvider.
+- put & delete, similar to get
+- add where to count, deleteMany,updateMany,
+- prevent delete all and update all - must have meaningful where.
+- try forcing this also in typescript
 
-In most cases you will not send anything - and it'll be by default remult.dataProvider.
+- protect against deleting of all rows by mistake
+- https://github.com/remult/remult/issues/221#issuecomment-2016519746
 
-I just findmyself creating remults to extract the data provider :)
 */
 //y1 - getFields didn't work for kobi in the home component
+//p1 - document offline support
 //p1 - add section to Fields doc, explaining field type in db
 //p1 - add section about union type
 //p1 - add section about value list field type

package/src/server-action.js

@@ -98,7 +98,7 @@ var Action = /** @class */ (function () {
                             // got a problem in next with instance of ForbiddenError  - so replaced it with this bool
                             res.forbidden();
                         else
-                            res.error(err_1);
+                            res.error(err_1, undefined);
                         return [3 /*break*/, 3];
                     case 3: return [2 /*return*/];
                 }
@@ -381,7 +381,7 @@ function BackendMethod(options) {
                                         // got a problem in next with instance of ForbiddenError  - so replaced it with this bool
                                         res.forbidden();
                                     else
-                                        res.error(err_3);
+                                        res.error(err_3, undefined);
                                     return [3 /*break*/, 4];
                                 case 4: return [2 /*return*/];
                             }