improve EnhanceApiContext and EnhanceServerContext

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log (@egomobile/next-utils)
 
+## 0.6.0
+
+- improve `EnhanceApiContext` and `EnhanceServerContext` using execution context objects instead
+
 ## 0.5.0
 
 - add `options` argument to `EnhanceApiContext` and `EnhanceServerContext`

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@egomobile/next-utils",
-    "version": "0.5.0",
+    "version": "0.6.0",
     "description": "Handy utils and extensions for Next.js",
     "main": "lib/index.js",
     "engines": {

src/middlewares/withApiProps.ts

@@ -25,13 +25,10 @@ import { asError } from "../utils/internal/asError";
 /**
  * Function that enhances an API context.
  *
- * @param {TContext} context The context to anhance.
- * @param {Nullable<Partial<IWithApiPropsOptions<TContext, TResponse>>>} options The underlying options.
- *
- * @returns {false|void|PromiseLike<void|false>} The `false`, the execution will be stopped.
+ * @param {IEnhanceApiContextContext<TContext, TResponse>} context The execution context.
  */
 export type EnhanceApiContext<TContext = IGetApiPropsActionContext<any>, TResponse = any> =
-    (context: TContext, options: Nullable<Partial<IWithApiPropsOptions<TContext, TResponse>>>) => false | void | PromiseLike<void | false>;
+    (context: IEnhanceApiContextExecutionContext<TContext, TResponse>) => void | PromiseLike<void>;
 
 /**
  * An action for a `getProps` value of an `IWithApiPropsOptions` instance.
@@ -76,6 +73,26 @@ export interface ICreateWithApiPropsOptions<TContext = IGetApiPropsActionContext
     onError?: Nilable<ServerErrorHandler>;
 }
 
+/**
+ * Context for an `EnhanceApiContext` function.
+ */
+export interface IEnhanceApiContextExecutionContext<TContext = IGetApiPropsActionContext<any>, TResponse = any> {
+    /**
+     * The context to enhance.
+     */
+    context: TContext;
+    /**
+     * The options.
+     */
+    options: Nullable<Partial<IWithApiPropsOptions<TContext, TResponse>>>;
+    /**
+     * Gets or sets if the execution should be stopped or not.
+     *
+     * @default `false`
+     */
+    shouldStop: boolean;
+}
+
 /**
  * Context for a `GetApiPropsAction` action.
  */
@@ -211,8 +228,14 @@ export function createWithApiProps<TContext = IGetApiPropsActionContext<any>>(
                         ...options
                     } : null;
 
-                    const shouldStop = ((await enhanceContext?.(getPropsContext as unknown as TContext, copyOfOptions)) as any) === false;
-                    if (shouldStop) {
+                    const enhanceExecCtx: IEnhanceApiContextExecutionContext<TContext, any> = {
+                        "context": getPropsContext as any,
+                        "options": copyOfOptions as any,
+                        "shouldStop": false
+                    };
+
+                    await enhanceContext?.(enhanceExecCtx);
+                    if (enhanceExecCtx.shouldStop) {
                         return;
                     }
 

src/middlewares/withServerProps.ts

@@ -24,11 +24,9 @@ import { wrapServerHandler } from "../utils/internal/wrapServerHandler";
  * Function that enhances a server context.
  *
  * @param {TContext} context The context to anhance.
- *
- * @returns {false|void|PromiseLike<void|false>} The `false`, the execution will be stopped.
  */
-export type EnhanceServerContext<TContext = IWithServerPropsActionContext, TResponse = any> =
-    (context: TContext, options: Nullable<Partial<IWithServerPropsOptions>>) => false | void | PromiseLike<void | false>;
+export type EnhanceServerContext<TContext = IWithServerPropsActionContext> =
+    (context: IEnhanceServerContextExecutionContext<TContext>) => void | PromiseLike<void>;
 
 /**
  * Options for `createWithServerProps()` function.
@@ -44,6 +42,30 @@ export interface ICreateWithServerPropsOptions<TContext = IWithServerPropsAction
     onError?: Nilable<ServerErrorHandler>;
 }
 
+/**
+ * Context for an `EnhanceServerContext` function.
+ */
+export interface IEnhanceServerContextExecutionContext<TContext = IWithServerPropsActionContext> {
+    /**
+     * The context to enhance.
+     */
+    context: TContext;
+    /**
+     * The options.
+     */
+    options: Nullable<Partial<IWithServerPropsOptions>>;
+    /**
+     * The props to return if execution will be stopped.
+     */
+    props: Record<string, any>;
+    /**
+     * Gets or sets if the execution should be stopped or not.
+     *
+     * @default `false`
+     */
+    shouldStop: boolean;
+}
+
 /**
  * A context for a `WithServerPropsAction` action.
  */
@@ -126,10 +148,18 @@ export function createWithServerProps<TContext = IWithServerPropsActionContext>(
                     ...options
                 } : null;
 
-                const shouldStop = ((await enhanceContext?.(actionContext as unknown as TContext, copyOfOptions)) as any) === false;
-                if (shouldStop) {
+                const enhanceExecCtx: IEnhanceServerContextExecutionContext<TContext> = {
+                    "context": actionContext as any,
+                    "options": copyOfOptions as any,
+                    "props": {},
+                    "shouldStop": false
+                };
+
+                await enhanceContext?.(enhanceExecCtx);
+
+                if (enhanceExecCtx.shouldStop) {
                     return {
-                        "props": {}
+                        "props": enhanceExecCtx.props ?? {}
                     };
                 }