remult 0.26.6-exp.0 → 0.26.7

package/esm/index.js

@@ -4,7 +4,7 @@ export { Entity } from './src/remult3/entity.js';
 export { getEntityRef } from './src/remult3/getEntityRef.js';
 export { Field, Fields, Relations, } from './src/remult3/Fields.js';
 export { IdEntity } from './src/remult3/IdEntity.js';
-export { describeClass } from './src/remult3/DecoratorReplacer.js';
+export { describeClass, describeBackendMethods, describeEntity, } from './src/remult3/classDescribers.js';
 export { RestDataProvider } from './src/data-providers/rest-data-provider.js'; //V
 export { InMemoryDataProvider } from './src/data-providers/in-memory-database.js'; //V
 export { WebSqlDataProvider } from './src/data-providers/web-sql-data-provider.js'; //V

package/esm/remult-sqlite3.js

@@ -0,0 +1,50 @@
+import { SqliteCoreDataProvider } from '../core/remult-sqlite-core.js';
+export class Sqlite3DataProvider extends SqliteCoreDataProvider {
+    constructor(db) {
+        super(() => new Sqlite3Command(db), async () => {
+            db.close();
+        });
+    }
+}
+class Sqlite3Command {
+    db;
+    values = {};
+    i = 1;
+    constructor(db) {
+        this.db = db;
+    }
+    async execute(sql) {
+        return new Promise((resolve, error) => {
+            this.db.all(sql, this.values, (err, rows) => {
+                console.log(sql, rows);
+                if (err)
+                    error(err);
+                else
+                    resolve(new Sqlite3SqlResult(rows));
+            });
+        });
+    }
+    addParameterAndReturnSqlToken(val) {
+        return this.param(val);
+    }
+    param(val) {
+        if (val instanceof Date)
+            val = val.valueOf();
+        if (typeof val === 'boolean')
+            val = val ? 1 : 0;
+        const key = ':' + this.i++;
+        this.values[key.substring(1)] = val;
+        return key;
+    }
+}
+export class Sqlite3SqlResult {
+    result;
+    constructor(result) {
+        this.result = result;
+        this.rows = result;
+    }
+    rows;
+    getColumnKeyInResultForIndexInSelect(index) {
+        return Object.keys(this.result[0])[index];
+    }
+}

package/esm/server/expressBridge.js

@@ -266,11 +266,14 @@ export class RemultServerImplementation {
     }
     //runs with remult but without init request
     async runWithRemult(what, options) {
+        let dataProvider;
+        if (!options?.skipDataProvider)
+            dataProvider = await this.dataProvider;
         return await withRemult(async (remult) => {
             var x = remult;
             x.liveQueryPublisher = new LiveQueryPublisher(() => remult.subscriptionServer, () => remult.liveQueryStorage, this.runWithSerializedJsonContextData);
             if (!options?.skipDataProvider)
-                x.dataProvider = await this.dataProvider;
+                x.dataProvider = dataProvider;
             x.subscriptionServer = this.subscriptionServer;
             x.liveQueryStorage = this.liveQueryStorage;
             return await what(x);

package/esm/src/remult3/RepositoryImplementation.js

@@ -1312,6 +1312,7 @@ export class rowHelperImplementation extends rowHelperBase {
                     }
                 }
                 await this.loadDataFrom(updatedRow);
+                e.id = this.getId();
                 if (!this.repository._dataProvider.isProxy) {
                     if (this.info.entityInfo.saved)
                         await this.info.entityInfo.saved(this.instance, e);

package/esm/src/remult3/{DecoratorReplacer.js → classDescribers.js}

@@ -1,6 +1,8 @@
-export function describeClass(classType, classDecorator, members, staticMembers) {
-    if (classDecorator)
-        classDecorator(classType);
+import { BackendMethod } from '../server-action.js';
+import { Entity } from './entity.js';
+export function describeClass(classType, classDescriber, members, staticMembers) {
+    if (classDescriber)
+        classDescriber(classType);
     for (const fieldKey in members) {
         if (Object.prototype.hasOwnProperty.call(members, fieldKey)) {
             const element = members[fieldKey];
@@ -18,3 +20,16 @@ export function describeClass(classType, classDecorator, members, staticMembers)
             Object.defineProperty(classType, staticFieldKey, prop);
     }
 }
+export function describeBackendMethods(classType, backendMethods) {
+    let result = {};
+    for (const key in backendMethods) {
+        if (Object.prototype.hasOwnProperty.call(backendMethods, key)) {
+            const options = backendMethods[key];
+            result[key] = BackendMethod(options);
+        }
+    }
+    describeClass(classType, undefined, undefined, result);
+}
+export function describeEntity(classType, key, fields, options) {
+    describeClass(classType, Entity(key, options), fields);
+}

package/esm/src/remult3/getEntityRef.js

@@ -1,3 +1,12 @@
+/**
+ * Retrieves the EntityRef object associated with the specified entity instance.
+ * The EntityRef provides methods for performing operations on the entity instance.
+ * @param {entityType} entity - The entity instance.
+ * @param {boolean} [throwException=true] - Indicates whether to throw an exception if the EntityRef object cannot be retrieved.
+ * @returns {EntityRef<entityType>} The EntityRef object associated with the specified entity instance.
+ * @throws {Error} If throwException is true and the EntityRef object cannot be retrieved.
+ * @see [Active Record & EntityBase](https://remult.dev/docs/active-record)
+ */
 export function getEntityRef(entity, throwException = true) {
     let x = entity[entityMember];
     if (!x && throwException)

package/esm/src/remult3/remult3.js

@@ -1,7 +1,20 @@
 export {};
+//p1 - remove controller and instance backend methods from the regular backend method article
+//p1 - describe entity
+//p1 - fix includeInApi documentation - figure out why we can't see the see?
 //y2 - soft-delete-discussion https://discord.com/channels/975754286384418847/1230386433093533698/1230386433093533698
-//y1 - In the esm version of our tutorial - the imports are automatically .ts and not .js
+//y1 - In the esm version of our tutorial - the imports are automatically .ts and not .js in react and not in vue
+//y1 - talk about insert with relations
 //y1 - consider id to also support keyof (id:['company','index']) - had problem with | (keyof Partial<entityType>)[] & `entity`
+//y1 - change exp version to preview?
+//y1 - talk about insert / update / delete with relations
+/*
+  repo(Order).insert({},{
+  relations:{
+    orderItems:[{},{},{}]
+  }
+})
+*/
 //y1 - repo batch - for multiple operations:
 /*
   const result = await repo.batch(x=>({
@@ -12,7 +25,6 @@ export {};
 //p1 - add documentation for bun sqlite
 //p1 - consider upsert (where,set)
 //p1 - wait a second to close stream
-//p1 - describe entity
 //p1 - prepare the createEntity discussion
 //p1 - write active record article
 //p1 - return error on connection error

package/index.d.ts

@@ -9,7 +9,7 @@ export { Entity } from './src/remult3/entity.js';
 export { getEntityRef } from './src/remult3/getEntityRef.js';
 export { Field, Fields, StringFieldOptions, Relations, } from './src/remult3/Fields.js';
 export { IdEntity } from './src/remult3/IdEntity.js';
-export { describeClass } from './src/remult3/DecoratorReplacer.js';
+export { describeClass, describeBackendMethods, describeEntity, } from './src/remult3/classDescribers.js';
 export { EntityOptions, PreprocessFilterEvent } from './src/entity.js';
 export { DataProvider, EntityDataProvider, EntityDataProviderFindOptions, ErrorInfo, RestDataProviderHttpProvider, } from './src/data-interfaces.js';
 export { SqlCommand, SqlCommandWithParameters, SqlImplementation, SqlResult, } from './src/sql-command.js';

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.repo = exports.SubscriptionChannel = exports.InMemoryLiveQueryStorage = exports.remult = exports.ValueConverters = exports.createValueValidator = exports.createValueValidatorWithArgs = exports.createValidatorWithArgs = exports.createValidator = exports.valueValidator = exports.Validators = exports.UrlBuilder = exports.Filter = exports.CompoundIdField = exports.Sort = exports.EventSource = exports.isBackend = exports.withRemult = exports.Remult = exports.Allow = exports.ForbiddenError = exports.ProgressListener = exports.BackendMethod = exports.Controller = exports.JsonEntityOpfsStorage = exports.JsonDataProvider = exports.dbNamesOf = exports.CustomSqlFilterBuilder = exports.SqlDatabase = exports.WebSqlDataProvider = exports.InMemoryDataProvider = exports.RestDataProvider = exports.describeClass = exports.IdEntity = exports.Relations = exports.Fields = exports.Field = exports.getEntityRef = exports.Entity = exports.CaptionTransformer = exports.ValueListInfo = exports.getValueList = exports.ValueListFieldType = exports.getFields = exports.FieldType = exports.ControllerBase = exports.EntityBase = exports.ArrayEntityDataProvider = void 0;
+exports.repo = exports.SubscriptionChannel = exports.InMemoryLiveQueryStorage = exports.remult = exports.ValueConverters = exports.createValueValidator = exports.createValueValidatorWithArgs = exports.createValidatorWithArgs = exports.createValidator = exports.valueValidator = exports.Validators = exports.UrlBuilder = exports.Filter = exports.CompoundIdField = exports.Sort = exports.EventSource = exports.isBackend = exports.withRemult = exports.Remult = exports.Allow = exports.ForbiddenError = exports.ProgressListener = exports.BackendMethod = exports.Controller = exports.JsonEntityOpfsStorage = exports.JsonDataProvider = exports.dbNamesOf = exports.CustomSqlFilterBuilder = exports.SqlDatabase = exports.WebSqlDataProvider = exports.InMemoryDataProvider = exports.RestDataProvider = exports.describeEntity = exports.describeBackendMethods = exports.describeClass = exports.IdEntity = exports.Relations = exports.Fields = exports.Field = exports.getEntityRef = exports.Entity = exports.CaptionTransformer = exports.ValueListInfo = exports.getValueList = exports.ValueListFieldType = exports.getFields = exports.FieldType = exports.ControllerBase = exports.EntityBase = exports.ArrayEntityDataProvider = void 0;
 var array_entity_data_provider_js_1 = require("./src/data-providers/array-entity-data-provider.js");
 Object.defineProperty(exports, "ArrayEntityDataProvider", { enumerable: true, get: function () { return array_entity_data_provider_js_1.ArrayEntityDataProvider; } });
 var RepositoryImplementation_js_1 = require("./src/remult3/RepositoryImplementation.js");
@@ -22,8 +22,10 @@ Object.defineProperty(exports, "Fields", { enumerable: true, get: function () {
 Object.defineProperty(exports, "Relations", { enumerable: true, get: function () { return Fields_js_1.Relations; } });
 var IdEntity_js_1 = require("./src/remult3/IdEntity.js");
 Object.defineProperty(exports, "IdEntity", { enumerable: true, get: function () { return IdEntity_js_1.IdEntity; } });
-var DecoratorReplacer_js_1 = require("./src/remult3/DecoratorReplacer.js");
-Object.defineProperty(exports, "describeClass", { enumerable: true, get: function () { return DecoratorReplacer_js_1.describeClass; } });
+var classDescribers_js_1 = require("./src/remult3/classDescribers.js");
+Object.defineProperty(exports, "describeClass", { enumerable: true, get: function () { return classDescribers_js_1.describeClass; } });
+Object.defineProperty(exports, "describeBackendMethods", { enumerable: true, get: function () { return classDescribers_js_1.describeBackendMethods; } });
+Object.defineProperty(exports, "describeEntity", { enumerable: true, get: function () { return classDescribers_js_1.describeEntity; } });
 var rest_data_provider_js_1 = require("./src/data-providers/rest-data-provider.js"); //V
 Object.defineProperty(exports, "RestDataProvider", { enumerable: true, get: function () { return rest_data_provider_js_1.RestDataProvider; } });
 var in_memory_database_js_1 = require("./src/data-providers/in-memory-database.js"); //V

package/package.json

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

package/remult-sqlite3.d.ts

@@ -0,0 +1,12 @@
+import { SqlResult } from '../core/index.js';
+import { SqliteCoreDataProvider } from '../core/remult-sqlite-core.js';
+import { Database } from 'sqlite3';
+export declare class Sqlite3DataProvider extends SqliteCoreDataProvider {
+    constructor(db: Database);
+}
+export declare class Sqlite3SqlResult implements SqlResult {
+    private result;
+    constructor(result: any[]);
+    rows: any[];
+    getColumnKeyInResultForIndexInSelect(index: number): string;
+}

package/remult-sqlite3.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sqlite3SqlResult = exports.Sqlite3DataProvider = void 0;
+var tslib_1 = require("tslib");
+var remult_sqlite_core_js_1 = require("../core/remult-sqlite-core.js");
+var Sqlite3DataProvider = /** @class */ (function (_super) {
+    tslib_1.__extends(Sqlite3DataProvider, _super);
+    function Sqlite3DataProvider(db) {
+        var _this = _super.call(this, function () { return new Sqlite3Command(db); }, function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                db.close();
+                return [2 /*return*/];
+            });
+        }); }) || this;
+        return _this;
+    }
+    return Sqlite3DataProvider;
+}(remult_sqlite_core_js_1.SqliteCoreDataProvider));
+exports.Sqlite3DataProvider = Sqlite3DataProvider;
+var Sqlite3Command = /** @class */ (function () {
+    function Sqlite3Command(db) {
+        this.db = db;
+        this.values = {};
+        this.i = 1;
+    }
+    Sqlite3Command.prototype.execute = function (sql) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, new Promise(function (resolve, error) {
+                        _this.db.all(sql, _this.values, function (err, rows) {
+                            console.log(sql, rows);
+                            if (err)
+                                error(err);
+                            else
+                                resolve(new Sqlite3SqlResult(rows));
+                        });
+                    })];
+            });
+        });
+    };
+    Sqlite3Command.prototype.addParameterAndReturnSqlToken = function (val) {
+        return this.param(val);
+    };
+    Sqlite3Command.prototype.param = function (val) {
+        if (val instanceof Date)
+            val = val.valueOf();
+        if (typeof val === 'boolean')
+            val = val ? 1 : 0;
+        var key = ':' + this.i++;
+        this.values[key.substring(1)] = val;
+        return key;
+    };
+    return Sqlite3Command;
+}());
+var Sqlite3SqlResult = /** @class */ (function () {
+    function Sqlite3SqlResult(result) {
+        this.result = result;
+        this.rows = result;
+    }
+    Sqlite3SqlResult.prototype.getColumnKeyInResultForIndexInSelect = function (index) {
+        return Object.keys(this.result[0])[index];
+    };
+    return Sqlite3SqlResult;
+}());
+exports.Sqlite3SqlResult = Sqlite3SqlResult;

package/server/expressBridge.js

@@ -499,31 +499,33 @@ var RemultServerImplementation = /** @class */ (function () {
     //runs with remult but without init request
     RemultServerImplementation.prototype.runWithRemult = function (what, options) {
         return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var dataProvider;
             var _this = this;
             return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, context_js_1.withRemult)(function (remult) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
-                            var x, _a;
-                            return tslib_1.__generator(this, function (_b) {
-                                switch (_b.label) {
+                    case 0:
+                        if (!!(options === null || options === void 0 ? void 0 : options.skipDataProvider)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.dataProvider];
+                    case 1:
+                        dataProvider = _a.sent();
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, (0, context_js_1.withRemult)(function (remult) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+                            var x;
+                            return tslib_1.__generator(this, function (_a) {
+                                switch (_a.label) {
                                     case 0:
                                         x = remult;
                                         x.liveQueryPublisher = new SubscriptionServer_js_1.LiveQueryPublisher(function () { return remult.subscriptionServer; }, function () { return remult.liveQueryStorage; }, this.runWithSerializedJsonContextData);
-                                        if (!!(options === null || options === void 0 ? void 0 : options.skipDataProvider)) return [3 /*break*/, 2];
-                                        _a = x;
-                                        return [4 /*yield*/, this.dataProvider];
-                                    case 1:
-                                        _a.dataProvider = _b.sent();
-                                        _b.label = 2;
-                                    case 2:
+                                        if (!(options === null || options === void 0 ? void 0 : options.skipDataProvider))
+                                            x.dataProvider = dataProvider;
                                         x.subscriptionServer = this.subscriptionServer;
                                         x.liveQueryStorage = this.liveQueryStorage;
                                         return [4 /*yield*/, what(x)];
-                                    case 3: return [2 /*return*/, _b.sent()];
+                                    case 1: return [2 /*return*/, _a.sent()];
                                 }
                             });
                         }); })];
-                    case 1: return [2 /*return*/, _a.sent()];
+                    case 3: return [2 /*return*/, _a.sent()];
                 }
             });
         });

package/src/column-interfaces.d.ts

@@ -11,11 +11,32 @@ export interface FieldOptions<entityType = any, valueType = any> {
     allowNull?: boolean;
     /** If a value is required */
     required?: boolean;
-    /** If this field data is included in the api.
-     * @see [allowed](http://remult.dev/docs/allowed.html)*/
+    /**
+     * Specifies whether this field should be included in the API. This can be configured
+     * based on access control levels.
+     * @example
+     * // Do not include in the API
+     * @Fields.string({ includeInApi: false })
+     * password = '';
+     * // Include in the API for 'admin' only
+     * @Fields.number({ includeInApi: 'admin' })
+     * salary = 0;
+     * @see [allowed](https://remult.dev/docs/allowed.html)
+     * @see [Access Control](https://remult.dev/docs/access-control)
+     * @type {AllowedForInstance<entityType>}
+     */
     includeInApi?: AllowedForInstance<entityType>;
-    /** If this field data can be updated in the api.
-     * @see [allowed](http://remult.dev/docs/allowed.html)*/
+    /**
+     * Determines whether this field can be updated via the API. This setting can also
+     * be controlled based on user roles or other access control checks.
+     * @example
+     * // Prevent API from updating this field
+     * @Fields.string({ allowApiUpdate: false })
+     * createdBy = remult.user?.id;
+     * @see [allowed](https://remult.dev/docs/allowed.html)
+     * @see [Access Control](https://remult.dev/docs/access-control)
+     * @type {AllowedForInstance<entityType>}
+     */
     allowApiUpdate?: AllowedForInstance<entityType>;
     /** An arrow function that'll be used to perform validations on it
      * @example
@@ -109,6 +130,7 @@ export interface FieldMetadata<valueType = any, entityType = any> {
     /** A human readable caption for the field. Can be used to achieve a consistent caption for a field throughout the app
      * @example
      * <input placeholder={taskRepo.metadata.fields.title.caption}/>
+     * @see {@link FieldOptions#caption} for configuration details
      */
     readonly caption: string;
     /** The name of the column in the database that holds the data for this field. If no name is set, the key will be used instead.
@@ -116,6 +138,7 @@ export interface FieldMetadata<valueType = any, entityType = any> {
      *
      * @Fields.string({ dbName: 'userName'})
      * userName=''
+     * @see {@link FieldOptions#dbName} for configuration details
      */
     dbName: string;
     /** The field's value type (number,string etc...) */
@@ -124,7 +147,10 @@ export interface FieldMetadata<valueType = any, entityType = any> {
     readonly options: FieldOptions;
     /** The `inputType` relevant for this field, determined by the options sent to it's decorator and the valueConverter in these options */
     readonly inputType: string;
-    /** if null is allowed for this field */
+    /** if null is allowed for this field
+     * @see {@link FieldOptions#allowNull} for configuration details
+     *
+     */
     readonly allowNull: boolean;
     /** The class that contains this field
      * @example
@@ -137,16 +163,45 @@ export interface FieldMetadata<valueType = any, entityType = any> {
     getDbName(): Promise<string>;
     /** Indicates if this field is based on a server express */
     readonly isServerExpression: boolean;
-    /** indicates that this field should only be included in select statement, and excluded from update or insert. useful for db generated ids etc... */
+    /** indicates that this field should only be included in select statement, and excluded from update or insert. useful for db generated ids etc...
+     * @see {@link FieldOptions#dbReadOnly} for configuration details
+     */
     readonly dbReadOnly: boolean;
     /** the Value converter for this field */
     readonly valueConverter: Required<ValueConverter<valueType>>;
     /** Get the display value for a specific item
+     * @see {@link FieldOptions#displayValue} for configuration details
      * @example
      * repo.fields.createDate.displayValue(task) //will display the date as defined in the `displayValue` option defined for it.
      */
     displayValue(item: Partial<entityType>): string;
+    /**
+   * Determines if the current user is allowed to update a specific entity instance.
+   
+   * @example
+   * const taskRepo = remult.repo(Task);
+   * // Check if the current user is allowed to update a specific task
+   * if (taskRepo.metadata.apiUpdateAllowed(task)){
+   *   // Allow user to edit the entity
+   * }
+   * @see {@link FieldOptions#allowApiUpdate} for configuration details
+   * @param {Partial<entityType>} item - Partial entity instance to check permissions against.
+   * @returns {boolean} True if the update is allowed.
+   */
     apiUpdateAllowed(item?: Partial<entityType>): boolean;
+    /**
+     * Determines if a specific entity field should be included in the API based on the current user's permissions.
+     * This method checks visibility permissions for a field within a partial entity instance.
+     * @example
+     * const employeeRepo = remult.repo(Employee);
+     * // Determine if the 'salary' field of an employee should be visible in the API for the current user
+     * if (employeeRepo.fields.salary.includedInApi({ id: 123, name: 'John Doe' })) {
+     *   // The salary field is included in the API
+     * }
+     * @see {@link FieldOptions#includeInApi} for configuration details
+     * @param {Partial<entityType>} item - The partial entity instance used to evaluate field visibility.
+     * @returns {boolean} True if the field is included in the API.
+     */
     includedInApi(item?: Partial<entityType>): boolean;
     /** Adapts the value for usage with html input
      * @example
@@ -154,6 +209,7 @@ export interface FieldMetadata<valueType = any, entityType = any> {
      * birthDate = new Date(1976,5,16)
      * //...
      * input.value = repo.fields.birthDate.toInput(person) // will return '1976-06-16'
+     * @see {@link ValueConverter#toInput} for configuration details
      */
     toInput(value: valueType, inputType?: string): string;
     /** Adapts the value for usage with html input
@@ -162,6 +218,7 @@ export interface FieldMetadata<valueType = any, entityType = any> {
      * birthDate = new Date(1976,5,16)
      * //...
      * person.birthDate = repo.fields.birthDate.fromInput(personFormState) // will return Date
+     * @see {@link ValueConverter#fromInput} for configuration details
      */
     fromInput(inputValue: string, inputType?: string): valueType;
 }

package/src/entity.d.ts

@@ -15,13 +15,19 @@ export interface EntityOptions<entityType = any> {
     allowApiRead?: Allowed;
     /**
      * Determines if this entity can be updated through the api.
-     * @see [allowed](http://remult.dev/docs/allowed.html)*/
+     * @see [allowed](http://remult.dev/docs/allowed.html)
+     * @see [Access Control](https://remult.dev/docs/access-control)
+     * */
     allowApiUpdate?: AllowedForInstance<entityType>;
     /** Determines if entries for this entity can be deleted through the api.
-     * @see [allowed](http://remult.dev/docs/allowed.html)*/
+     * @see [allowed](http://remult.dev/docs/allowed.html)
+     * @see [Access Control](https://remult.dev/docs/access-control)
+     * */
     allowApiDelete?: AllowedForInstance<entityType>;
     /** Determines if new entries for this entity can be posted through the api.
-     * @see [allowed](http://remult.dev/docs/allowed.html)*/
+     * @see [allowed](http://remult.dev/docs/allowed.html)
+     * @see [Access Control](https://remult.dev/docs/access-control)
+     * */
     allowApiInsert?: AllowedForInstance<entityType>;
     /** sets  the `allowApiUpdate`, `allowApiDelete` and `allowApiInsert` properties in a single set */
     allowApiCrud?: Allowed;
@@ -190,7 +196,7 @@ export interface PreprocessFilterEvent<entityType> {
      * @param filter Optional filter to analyze. If not provided, the current filter being preprocessed is used.
      * @returns A promise that resolves to a FilterPreciseValues object containing the precise values for each property.
      
-    * {@Link FilterPreciseValues }
+    * @see {@Link FilterPreciseValues }
      */
     getFilterPreciseValues(filter?: EntityFilter<entityType>): Promise<FilterPreciseValues<entityType>>;
 }

package/src/remult3/RepositoryImplementation.js

@@ -2185,6 +2185,7 @@ var rowHelperImplementation = /** @class */ (function (_super) {
                     case 20: return [4 /*yield*/, this.loadDataFrom(updatedRow)];
                     case 21:
                         _p.sent();
+                        e.id = this.getId();
                         if (!!this.repository._dataProvider.isProxy) return [3 /*break*/, 31];
                         if (!this.info.entityInfo.saved) return [3 /*break*/, 23];
                         return [4 /*yield*/, this.info.entityInfo.saved(this.instance, e)];

package/src/remult3/classDescribers.d.ts

@@ -0,0 +1,16 @@
+import { ClassType } from '../../classType.js';
+import { EntityOptions } from '../entity.js';
+import { BackendMethodOptions } from '../server-action.js';
+type Descriptor<T = any> = (a: T, b: string, c?: any) => void;
+type FieldsDescriptor<T> = T extends new (...args: any[]) => infer R ? {
+    [K in keyof R]?: Descriptor;
+} : never;
+type StaticMemberDescriptors<T> = {
+    [K in keyof T]?: Descriptor;
+};
+export declare function describeClass<classType>(classType: classType, classDescriber: ((x: any, context?: any) => any) | undefined, members?: FieldsDescriptor<classType> | undefined, staticMembers?: StaticMemberDescriptors<classType>): void;
+export declare function describeBackendMethods<T>(classType: T, backendMethods: {
+    [K in keyof T]?: BackendMethodOptions<unknown>;
+}): void;
+export declare function describeEntity<entityType extends ClassType<any>>(classType: entityType, key: string, fields: FieldsDescriptor<entityType>, options?: EntityOptions<InstanceType<entityType>>): void;
+export {};

package/src/remult3/classDescribers.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.describeEntity = exports.describeBackendMethods = exports.describeClass = void 0;
+var server_action_js_1 = require("../server-action.js");
+var entity_js_1 = require("./entity.js");
+function describeClass(classType, classDescriber, members, staticMembers) {
+    if (classDescriber)
+        classDescriber(classType);
+    for (var fieldKey in members) {
+        if (Object.prototype.hasOwnProperty.call(members, fieldKey)) {
+            var element = members[fieldKey];
+            var prop = Object.getOwnPropertyDescriptor(classType.prototype, fieldKey);
+            element(classType.prototype, fieldKey, prop);
+            if (prop)
+                Object.defineProperty(classType.prototype, fieldKey, prop);
+        }
+    }
+    for (var staticFieldKey in staticMembers) {
+        var staticElement = staticMembers[staticFieldKey];
+        var prop = Object.getOwnPropertyDescriptor(classType, staticFieldKey);
+        staticElement(classType, staticFieldKey, prop);
+        if (prop)
+            Object.defineProperty(classType, staticFieldKey, prop);
+    }
+}
+exports.describeClass = describeClass;
+function describeBackendMethods(classType, backendMethods) {
+    var result = {};
+    for (var key in backendMethods) {
+        if (Object.prototype.hasOwnProperty.call(backendMethods, key)) {
+            var options = backendMethods[key];
+            result[key] = (0, server_action_js_1.BackendMethod)(options);
+        }
+    }
+    describeClass(classType, undefined, undefined, result);
+}
+exports.describeBackendMethods = describeBackendMethods;
+function describeEntity(classType, key, fields, options) {
+    describeClass(classType, (0, entity_js_1.Entity)(key, options), fields);
+}
+exports.describeEntity = describeEntity;

package/src/remult3/getEntityRef.d.ts

@@ -1,6 +1,15 @@
 import type { ClassType } from '../../classType.js';
 import type { EntityOptionsFactory } from './RepositoryImplementation.js';
 import type { EntityRef } from './remult3.js';
+/**
+ * Retrieves the EntityRef object associated with the specified entity instance.
+ * The EntityRef provides methods for performing operations on the entity instance.
+ * @param {entityType} entity - The entity instance.
+ * @param {boolean} [throwException=true] - Indicates whether to throw an exception if the EntityRef object cannot be retrieved.
+ * @returns {EntityRef<entityType>} The EntityRef object associated with the specified entity instance.
+ * @throws {Error} If throwException is true and the EntityRef object cannot be retrieved.
+ * @see [Active Record & EntityBase](https://remult.dev/docs/active-record)
+ */
 export declare function getEntityRef<entityType>(entity: entityType, throwException?: boolean): EntityRef<entityType>;
 export declare const entityMember: unique symbol;
 export declare const entityInfo: unique symbol;

package/src/remult3/getEntityRef.js

@@ -1,6 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getEntityKey = exports.getEntitySettings = exports.entityInfo_key = exports.entityInfo = exports.entityMember = exports.getEntityRef = void 0;
+/**
+ * Retrieves the EntityRef object associated with the specified entity instance.
+ * The EntityRef provides methods for performing operations on the entity instance.
+ * @param {entityType} entity - The entity instance.
+ * @param {boolean} [throwException=true] - Indicates whether to throw an exception if the EntityRef object cannot be retrieved.
+ * @returns {EntityRef<entityType>} The EntityRef object associated with the specified entity instance.
+ * @throws {Error} If throwException is true and the EntityRef object cannot be retrieved.
+ * @see [Active Record & EntityBase](https://remult.dev/docs/active-record)
+ */
 function getEntityRef(entity, throwException) {
     var _a;
     if (throwException === void 0) { throwException = true; }

package/src/remult3/remult3.d.ts

@@ -188,17 +188,22 @@ export interface EntityMetadata<entityType = any> {
     /** A human readable caption for the entity. Can be used to achieve a consistent caption for a field throughout the app
      * @example
      * <h1>Create a new item in {taskRepo.metadata.caption}</h1>
+     * @see {@link EntityOptions.caption}
      */
     readonly caption: string;
     /** The name of the table in the database that holds the data for this entity.
      * If no name is set in the entity options, the `key` will be used instead.
+     * @see {@link EntityOptions.dbName}
      */
     readonly dbName: string;
-    /** The options send to the `Entity`'s decorator */
+    /** The options send to the `Entity`'s decorator
+     * @see {@link EntityOptions}
+     */
     readonly options: EntityOptions;
     /** The class type of the entity */
     readonly entityType: ClassType<entityType>;
     /** true if the current user is allowed to update an entity instance
+     * @see {@link EntityOptions.allowApiUpdate
      * @example
      * const taskRepo = remult.repo(Task);
      * if (taskRepo.metadata.apiUpdateAllowed(task)){
@@ -207,6 +212,7 @@ export interface EntityMetadata<entityType = any> {
      */
     apiUpdateAllowed(item?: entityType): boolean;
     /** true if the current user is allowed to read from entity
+     * @see {@link EntityOptions.allowApiRead}
      * @example
      * const taskRepo = remult.repo(Task);
      * if (taskRepo.metadata.apiReadAllowed){
@@ -215,6 +221,7 @@ export interface EntityMetadata<entityType = any> {
      */
     readonly apiReadAllowed: boolean;
     /** true if the current user is allowed to delete an entity instance
+     * * @see {@link EntityOptions.allowApiDelete}
      * @example
      * const taskRepo = remult.repo(Task);
      * if (taskRepo.metadata.apiDeleteAllowed(task)){
@@ -223,6 +230,7 @@ export interface EntityMetadata<entityType = any> {
      */
     apiDeleteAllowed(item?: entityType): boolean;
     /** true if the current user is allowed to create an entity instance
+     * @see {@link EntityOptions.allowApiInsert}
      * @example
      * const taskRepo = remult.repo(Task);
      * if (taskRepo.metadata.apiInsertAllowed(task)){
@@ -233,7 +241,10 @@ export interface EntityMetadata<entityType = any> {
     /**
      * @deprecated Returns the dbName - based on it's `dbName` option and it's `sqlExpression` option */
     getDbName(): Promise<string>;
-    /** Metadata for the Entity's id */
+    /** Metadata for the Entity's id
+     * @see {@link EntityOptions.id} for configuration
+     *
+     */
     readonly idMetadata: IdMetadata<entityType>;
 }
 export declare type MembersOnly<T> = {

package/src/remult3/remult3.js

@@ -1,8 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+//p1 - remove controller and instance backend methods from the regular backend method article
+//p1 - describe entity
+//p1 - fix includeInApi documentation - figure out why we can't see the see?
 //y2 - soft-delete-discussion https://discord.com/channels/975754286384418847/1230386433093533698/1230386433093533698
-//y1 - In the esm version of our tutorial - the imports are automatically .ts and not .js
+//y1 - In the esm version of our tutorial - the imports are automatically .ts and not .js in react and not in vue
+//y1 - talk about insert with relations
 //y1 - consider id to also support keyof (id:['company','index']) - had problem with | (keyof Partial<entityType>)[] & `entity`
+//y1 - change exp version to preview?
+//y1 - talk about insert / update / delete with relations
+/*
+  repo(Order).insert({},{
+  relations:{
+    orderItems:[{},{},{}]
+  }
+})
+*/
 //y1 - repo batch - for multiple operations:
 /*
   const result = await repo.batch(x=>({
@@ -13,7 +26,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 //p1 - add documentation for bun sqlite
 //p1 - consider upsert (where,set)
 //p1 - wait a second to close stream
-//p1 - describe entity
 //p1 - prepare the createEntity discussion
 //p1 - write active record article
 //p1 - return error on connection error

package/src/remult3/DecoratorReplacer.d.ts

@@ -1,9 +0,0 @@
-type Decorator<T = any> = (a: T, b: string, c?: any) => void;
-type Decorators<T> = T extends new (...args: any[]) => infer R ? {
-    [K in keyof R]?: Decorator;
-} : never;
-type StaticDecorators<T> = {
-    [K in keyof T]?: Decorator;
-};
-export declare function describeClass<classType>(classType: classType, classDecorator: ((x: any, context?: any) => any) | undefined, members?: Decorators<classType> | undefined, staticMembers?: StaticDecorators<classType>): void;
-export {};

package/src/remult3/DecoratorReplacer.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.describeClass = void 0;
-function describeClass(classType, classDecorator, members, staticMembers) {
-    if (classDecorator)
-        classDecorator(classType);
-    for (var fieldKey in members) {
-        if (Object.prototype.hasOwnProperty.call(members, fieldKey)) {
-            var element = members[fieldKey];
-            var prop = Object.getOwnPropertyDescriptor(classType.prototype, fieldKey);
-            element(classType.prototype, fieldKey, prop);
-            if (prop)
-                Object.defineProperty(classType.prototype, fieldKey, prop);
-        }
-    }
-    for (var staticFieldKey in staticMembers) {
-        var staticElement = staticMembers[staticFieldKey];
-        var prop = Object.getOwnPropertyDescriptor(classType, staticFieldKey);
-        staticElement(classType, staticFieldKey, prop);
-        if (prop)
-            Object.defineProperty(classType, staticFieldKey, prop);
-    }
-}
-exports.describeClass = describeClass;