remult 3.2.0 → 3.2.2-next.0

package/server/remult-api-server.d.ts

@@ -23,16 +23,16 @@ export interface RemultServerOptions<RequestType> {
      * @see [Connecting to a Database](https://remult.dev/docs/databases.html).
      */
     dataProvider?: DataProvider | Promise<DataProvider> | (() => Promise<DataProvider | undefined>);
-    /** Will create tables and columns in supporting databases. default: true
+    /** Will create tables and columns in supporting databases.
+     *
+     * @default true
      *
-     * @description
      * when set to true, it'll create entities that do not exist, and add columns that are missing.
      */
     ensureSchema?: boolean;
-    /** The path to use for the api, default:/api
+    /** The path to use for the api, if you want to use a different path adjust this field
      *
-     * @description
-     * If you want to use a different api path adjust this field
+     * @default `/api`
      */
     rootPath?: string;
     /** The default limit to use for find requests that did not specify a limit */

package/src/column-interfaces.d.ts

@@ -4,12 +4,16 @@ import type { EntityMetadata, FieldRef, LifecycleEvent, ValidateFieldEvent } fro
 export interface FieldOptions<entityType = unknown, valueType = unknown> {
     /** A human readable name 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}/>
+     * ```html
+     * <input placeholder={taskRepo.metadata.fields.title.caption} />
+     * ```
      */
     caption?: string;
     /** A human readable name for the field. Can be used to achieve a consistent label for a field throughout the app
      * @example
-     * <input placeholder={taskRepo.metadata.fields.title.label}/>
+     * ```html
+     * <input placeholder={taskRepo.metadata.fields.title.label} />
+     * ```
      */
     label?: string;
     /** If it can store `null` in the database. @default false */

package/src/entity.d.ts

@@ -13,8 +13,6 @@ export interface EntityOptions<entityType = unknown> {
     label?: string;
     /**
      * Determines if this Entity is available for get requests using Rest Api
-     * @description
-     * Determines if one has any access to the data of an entity.
      * @see [allowed](http://remult.dev/docs/allowed.html)
      * @see to restrict data based on a criteria, use [apiPrefilter](https://remult.dev/docs/ref_entity.html#apiprefilter)
      * */
@@ -115,7 +113,7 @@ export interface EntityOptions<entityType = unknown> {
      *   },
      * })
      * @param entity - The instance of the entity being saved.
-     * @param event - an @link LifeCycleEvent object
+     * @param event - [Entity Lifecycle Hooks](http://remult.dev/docs/lifecycle-hooks#lifecycle-event-args)
      * @see [Entity Lifecycle Hooks](http://remult.dev/docs/lifecycle-hooks)
      */
     saving?: (entity: entityType, event: LifecycleEvent<entityType>) => Promise<any> | any;
@@ -123,7 +121,7 @@ export interface EntityOptions<entityType = unknown> {
      * A hook that runs after an entity has been successfully saved.
      *
      * @param entity The instance of the entity that was saved.
-     * @param event - an @link LifeCycleEvent object
+     * @param event - [Entity Lifecycle Hooks](http://remult.dev/docs/lifecycle-hooks#lifecycle-event-args)
      * @see [Entity Lifecycle Hooks](http://remult.dev/docs/lifecycle-hooks)
      */
     saved?: (entity: entityType, e: LifecycleEvent<entityType>) => Promise<any> | any;
@@ -131,7 +129,7 @@ export interface EntityOptions<entityType = unknown> {
      * A hook that runs before an entity is deleted.
      *
      * @param entity The instance of the entity being deleted.
-     * @param event - an @link LifeCycleEvent object
+     * @param event - [Entity Lifecycle Hooks](http://remult.dev/docs/lifecycle-hooks#lifecycle-event-args)
      * @see [Entity Lifecycle Hooks](http://remult.dev/docs/lifecycle-hooks)
      */
     deleting?: (entity: entityType, e: LifecycleEvent<entityType>) => Promise<any> | any;
@@ -139,7 +137,7 @@ export interface EntityOptions<entityType = unknown> {
      * A hook that runs after an entity has been successfully deleted.
      *
      * @param entity The instance of the entity that was deleted.
-     * @param event - an @link LifeCycleEvent object
+     * @param event - [Entity Lifecycle Hooks](http://remult.dev/docs/lifecycle-hooks#lifecycle-event-args)
      * @see [Entity Lifecycle Hooks](http://remult.dev/docs/lifecycle-hooks)
      */
     deleted?: (entity: entityType, e: LifecycleEvent<entityType>) => Promise<any> | any;
@@ -148,7 +146,7 @@ export interface EntityOptions<entityType = unknown> {
      * This hook is also executed on the frontend.
      *
      * @param entity The instance of the entity being validated.
-     * @param event - an @link LifeCycleEvent object
+     * @param event - [Entity Lifecycle Hooks](http://remult.dev/docs/lifecycle-hooks#lifecycle-event-args)
      * @see [Entity Lifecycle Hooks](http://remult.dev/docs/lifecycle-hooks)
      */
     validation?: (entity: entityType, ref: LifecycleEvent<entityType>) => Promise<any> | any;
@@ -213,8 +211,7 @@ export interface PreprocessFilterEvent<entityType> {
      * Retrieves precise values for each property in a filter for an entity.
      * @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.
-     
-    * @see {@Link FilterPreciseValues }
+     * @see {@link FilterPreciseValues}
      */
     getFilterPreciseValues(filter?: EntityFilter<entityType>): Promise<FilterPreciseValues<entityType>>;
 }

package/src/remult3/Fields.d.ts

@@ -119,18 +119,18 @@ export declare class Relations {
      * @returns A decorator function to apply the to-one relation to an entity field.
      *
      * Example usage:
-     * ```
+     * ```ts
      * @Relations.toOne(() => Customer)
      * customer?: Customer;
      * ```
-     * ```
+     * ```ts
      * Fields.string()
      * customerId?: string;
      *
      * @Relations.toOne(() => Customer, "customerId")
      * customer?: Customer;
      * ```
-     * ```
+     * ```ts
      * Fields.string()
      * customerId?: string;
      *
@@ -140,7 +140,7 @@ export declare class Relations {
      * })
      * customer?: Customer;
      * ```
-     * ```
+     * ```ts
      * Fields.string()
      * customerId?: string;
      *
@@ -163,7 +163,7 @@ export declare class Relations {
      * @returns A decorator function to apply the toMany relation to an entity field.
      *
      * Example usage:
-     * ```
+     * ```ts
      * @Relations.toMany(() => Order)
      * orders?: Order[];
      *
@@ -187,7 +187,7 @@ export declare class Relations {
      * @returns A decorator function to apply the toMany relation to an entity field.
      *
      * Example usage:
-     * ```
+     * ```ts
      * @Relations.toMany(() => Order, {
      *   field: "customerOrders",
      *   findOptions: {

package/src/remult3/Fields.js

@@ -320,18 +320,18 @@ var Relations = /** @class */ (function () {
      * @returns A decorator function to apply the to-one relation to an entity field.
      *
      * Example usage:
-     * ```
+     * ```ts
      * @Relations.toOne(() => Customer)
      * customer?: Customer;
      * ```
-     * ```
+     * ```ts
      * Fields.string()
      * customerId?: string;
      *
      * @Relations.toOne(() => Customer, "customerId")
      * customer?: Customer;
      * ```
-     * ```
+     * ```ts
      * Fields.string()
      * customerId?: string;
      *
@@ -341,7 +341,7 @@ var Relations = /** @class */ (function () {
      * })
      * customer?: Customer;
      * ```
-     * ```
+     * ```ts
      * Fields.string()
      * customerId?: string;
      *

package/src/remult3/entity.d.ts

@@ -4,6 +4,7 @@ import type { ClassDecoratorContextStub } from './remult3.js';
 /**Decorates classes that should be used as entities.
  * Receives a key and an array of EntityOptions.
  * @example
+ * ```ts
  * import  { Entity, Fields } from "remult";
  * @Entity("tasks", {
  *    allowApiCrud: true
@@ -16,13 +17,17 @@ import type { ClassDecoratorContextStub } from './remult3.js';
  *    @Fields.boolean()
  *    completed = false;
  * }
- * @note
+ * ```
  * EntityOptions can be set in two ways:
  * @example
+ * ```ts
  * // as an object
  * @Entity("tasks",{ allowApiCrud:true })
+ * ```
  * @example
+ * ```ts
  * // as an arrow function that receives `remult` as a parameter
  * @Entity("tasks", (options,remult) => options.allowApiCrud = true)
+ * ```
  */
 export declare function Entity<entityType>(key: string, ...options: (EntityOptions<entityType extends new (...args: any) => any ? InstanceType<entityType> : entityType> | ((options: EntityOptions<entityType extends new (...args: any) => any ? InstanceType<entityType> : entityType>, remult: Remult) => void))[]): (target: any, info?: ClassDecoratorContextStub<entityType extends new (...args: any) => any ? entityType : never>) => any;

package/src/remult3/entity.js

@@ -8,6 +8,7 @@ var remult_static_js_1 = require("../remult-static.js");
 /**Decorates classes that should be used as entities.
  * Receives a key and an array of EntityOptions.
  * @example
+ * ```ts
  * import  { Entity, Fields } from "remult";
  * @Entity("tasks", {
  *    allowApiCrud: true
@@ -20,14 +21,18 @@ var remult_static_js_1 = require("../remult-static.js");
  *    @Fields.boolean()
  *    completed = false;
  * }
- * @note
+ * ```
  * EntityOptions can be set in two ways:
  * @example
+ * ```ts
  * // as an object
  * @Entity("tasks",{ allowApiCrud:true })
+ * ```
  * @example
+ * ```ts
  * // as an arrow function that receives `remult` as a parameter
  * @Entity("tasks", (options,remult) => options.allowApiCrud = true)
+ * ```
  */
 function Entity(key) {
     var options = [];

package/src/remult3/remult3.d.ts

@@ -216,11 +216,13 @@ export interface EntityMetadata<entityType = unknown> {
     /** 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
+     * @see {@link EntityOptions.allowApiUpdate}
      * @example
+     * ```ts
      * if (repo(Task).metadata.apiUpdateAllowed(task)){
      *   // Allow user to edit the entity
      * }
+     * ```
      */
     apiUpdateAllowed(item?: entityType): boolean;
     /** true if the current user is allowed to read from entity
@@ -232,7 +234,7 @@ export interface EntityMetadata<entityType = unknown> {
      */
     readonly apiReadAllowed: boolean;
     /** true if the current user is allowed to delete an entity instance
-     * * @see {@link EntityOptions.allowApiDelete}
+     * @see {@link EntityOptions.allowApiDelete}
      * @example
      * if (repo(Task).metadata.apiDeleteAllowed(task)){
      *   // display delete button
@@ -652,7 +654,7 @@ export interface Repository<entityType> {
      */
     fields: FieldsMetadata<entityType>;
     /**The metadata for the `entity`
-     * @See [EntityMetadata](https://remult.dev/docs/ref_entitymetadata.html)
+     * @see [EntityMetadata](https://remult.dev/docs/ref_entitymetadata.html)
      */
     metadata: EntityMetadata<entityType>;
     addEventListener(listener: entityEventListener<entityType>): Unsubscribe;
@@ -1029,7 +1031,7 @@ export interface LoadOptions<entityType> {
      * @param include An object specifying the related entities to include, their options, and filtering criteria.
      *
      * Example usage:
-     * ```
+     * ```ts
      * const orders = await customerRepo.find({
      *   include: {
      *     // Include the 'tags' relation for each customer.

package/src/standard-schema/index.d.ts

@@ -6,7 +6,7 @@ interface RemultEntitySchema<entityType, fields extends string[] = []> extends S
 /**
  * Implementation of the [Standard Schema](https://standardschema.dev/) specification
  *
- * @usage
+ * @example
  * ```ts
  * // The schema for the entire entity
  * const schema = standardSchema(repo(User))

package/src/standard-schema/index.js

@@ -5,7 +5,7 @@ var tslib_1 = require("tslib");
 /**
  * Implementation of the [Standard Schema](https://standardschema.dev/) specification
  *
- * @usage
+ * @example
  * ```ts
  * // The schema for the entire entity
  * const schema = standardSchema(repo(User))