remult 0.27.2-next.0 → 0.27.3

package/README.md

@@ -41,6 +41,8 @@ Remult uses **TypeScript entities** as a single source of truth for: ✅ CRUD +
 
 **Remult is frontend and backend framework agnostic** and comes with adapters for Express, Fastify, Next.js, Nuxt, SvelteKit, SolidStart, Nest, Koa, Hapi and Hono.
 
+> **Want to experience Remult firsthand? [Try our interactive online tutorial](https://learn.remult.dev/).**
+
 Remult promotes a **consistent query syntax for both frontend and Backend code**:
 
 ```ts

package/esm/server/remult-api-server.js

@@ -303,6 +303,7 @@ export class RemultServerImplementation {
                 else
                     await this.runWithRemult(async (remult) => {
                         if (req) {
+                            ;
                             remult.context.request = req;
                             remultStatic.asyncContext.setInInitRequest(true);
                             try {

package/package.json

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

package/server/remult-api-server.js

@@ -590,6 +590,7 @@ var RemultServerImplementation = /** @class */ (function () {
                                 switch (_a.label) {
                                     case 0:
                                         if (!req) return [3 /*break*/, 8];
+                                        ;
                                         remult.context.request = req;
                                         remult_static_js_1.remultStatic.asyncContext.setInInitRequest(true);
                                         _a.label = 1;

package/src/context.d.ts

@@ -85,22 +85,17 @@ export declare class Remult {
 export type GetArguments<T> = T extends (...args: infer FirstArgument) => any ? FirstArgument : never;
 /**
  * This type represents the context object available through `remult.context`
- * It can be used to store custom information that will be available throughout the request lifecycle.
+ * If its used within the request lifecycle it's `request` member will be set automatically.
+ * To type it correctly, you can extend it with your own properties.
  * @example
- * remult.context.myCustomData = 'hello'
- */
+ * import type express from 'express'
+ * declare module 'remult' {
+ *   export interface RemultContext {
+ *     request?: express.Request
+ *   }
+ * }
+ *  */
 export interface RemultContext {
-    /** When running on the backend as part of a request, will have the request object.
-     * You can type it to your specific type
-     * @example
-     * import type express from 'express'
-     * declare module 'remult' {
-     *   export interface RemultContext {
-     *     request?: express.Request
-     *   }
-     * }
-     *  */
-    request?: unknown;
 }
 /**
  * Interface for configuring the API client used by Remult to perform HTTP calls to the backend.

package/src/remult3/remult3.d.ts

@@ -838,7 +838,7 @@ export interface Paginator<entityType> {
  * @template matchIdEntity The type used for matching IDs in the relation.
  * @template optionsType The type of find options to apply to the relation (default is FindOptionsBase<toEntity>).
  */
-export type RelationOptions<fromEntity, toEntity, matchIdEntity, optionsType extends FindOptionsBase<toEntity> = FindOptionsBase<toEntity>> = {
+export interface RelationOptions<fromEntity, toEntity, matchIdEntity, optionsType extends FindOptionsBase<toEntity> = FindOptionsBase<toEntity>> extends Pick<FieldOptions, 'caption'> {
     /**
      * An object specifying custom field names for the relation.
      * Each key represents a field in the related entity, and its value is the corresponding field in the source entity.
@@ -865,7 +865,7 @@ export type RelationOptions<fromEntity, toEntity, matchIdEntity, optionsType ext
      * If false or not specified, related entities will need to be explicitly included using the `include` option.
      */
     defaultIncluded?: boolean;
-} & Pick<FieldOptions, 'caption'>;
+}
 export type ObjectMembersOnly<T> = MembersOnly<{
     [K in keyof Pick<T, {
         [K in keyof T]: T[K] extends object | undefined | null ? T[K] extends Date | undefined | null ? never : K : never;