@faasjs/http 3.3.0 → 3.5.0

package/README.md

@@ -14,6 +14,7 @@ npm install @faasjs/http
 ## Functions
 
 - [useHttp](functions/useHttp.md)
+- [useHttpFunc](functions/useHttpFunc.md)
 
 ## Classes
 
@@ -27,6 +28,7 @@ npm install @faasjs/http
 
 - [CookieOptions](type-aliases/CookieOptions.md)
 - [HttpConfig](type-aliases/HttpConfig.md)
+- [HttpFuncHandler](type-aliases/HttpFuncHandler.md)
 - [Response](type-aliases/Response.md)
 - [SessionOptions](type-aliases/SessionOptions.md)
 - [ValidatorConfig](type-aliases/ValidatorConfig.md)

package/dist/index.d.mts

@@ -1,3 +1,4 @@
+import * as _faasjs_func from '@faasjs/func';
 import { Plugin, MountData, Next, InvokeData, UseifyPlugin } from '@faasjs/func';
 import { Logger } from '@faasjs/logger';
 
@@ -135,21 +136,6 @@ declare class Validator<TParams extends Record<string, any> = any, TCookie exten
     }, baseKey: string, config: ValidatorOptions, logger: Logger): void;
 }
 
-/**
- * FaasJS's http plugin.
- *
- * [![License: MIT](https://img.shields.io/npm/l/@faasjs/http.svg)](https://github.com/faasjs/faasjs/blob/main/packages/http/LICENSE)
- * [![NPM Version](https://img.shields.io/npm/v/@faasjs/http.svg)](https://www.npmjs.com/package/@faasjs/http)
- *
- * ## Install
- *
- * ```sh
- * npm install @faasjs/http
- * ```
- *
- * @packageDocumentation
- */
-
 declare const ContentType: {
     [key: string]: string;
 };
@@ -227,5 +213,33 @@ declare class Http<TParams extends Record<string, any> = any, TCookie extends Re
     setBody(body: string): Http<TParams, TCookie, TSession>;
 }
 declare function useHttp<TParams extends Record<string, any> = any, TCookie extends Record<string, string> = any, TSession extends Record<string, string> = any>(config?: HttpConfig<TParams, TCookie, TSession>): UseifyPlugin<Http<TParams, TCookie, TSession>>;
+type HttpFuncHandler<TParams extends Record<string, any> = Record<string, any>, TCookie extends Record<string, string> = Record<string, string>, TSession extends Record<string, any> = Record<string, any>, TResult = any> = (data: InvokeData<{
+    [key: string]: any;
+    params?: TParams;
+}> & {
+    params?: TParams;
+    cookie?: Cookie<TCookie, TSession>;
+    session?: Session<TSession, TCookie>;
+}) => Promise<TResult>;
+/**
+ * A hook to create an HTTP function with specified handler and configuration.
+ *
+ * @template TParams - The type of the parameters object.
+ * @template TCookie - The type of the cookies object.
+ * @template TSession - The type of the session object.
+ * @template TResult - The type of the result.
+ *
+ * @param {() => HttpFuncHandler<TParams, TCookie, TSession, TResult>} handler - The function handler to be used.
+ * @param {Object} [config] - Optional configuration object.
+ * @param {HttpConfig} [config.http] - Optional HTTP configuration.
+ *
+ * @returns {Function} The created HTTP function.
+ */
+declare function useHttpFunc<TParams extends Record<string, any> = Record<string, any>, TCookie extends Record<string, string> = Record<string, string>, TSession extends Record<string, any> = Record<string, any>, TResult = any>(handler: () => HttpFuncHandler<TParams, TCookie, TSession, TResult>, config?: {
+    http?: HttpConfig;
+}): _faasjs_func.Func<{
+    [key: string]: any;
+    params?: TParams;
+}, any, TResult>;
 
-export { ContentType, Cookie, type CookieOptions, Http, type HttpConfig, HttpError, type Response, Session, type SessionOptions, Validator, type ValidatorConfig, type ValidatorOptions, type ValidatorRuleOptions, useHttp };
+export { ContentType, Cookie, type CookieOptions, Http, type HttpConfig, HttpError, type HttpFuncHandler, type Response, Session, type SessionOptions, Validator, type ValidatorConfig, type ValidatorOptions, type ValidatorRuleOptions, useHttp, useHttpFunc };

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import * as _faasjs_func from '@faasjs/func';
 import { Plugin, MountData, Next, InvokeData, UseifyPlugin } from '@faasjs/func';
 import { Logger } from '@faasjs/logger';
 
@@ -135,21 +136,6 @@ declare class Validator<TParams extends Record<string, any> = any, TCookie exten
     }, baseKey: string, config: ValidatorOptions, logger: Logger): void;
 }
 
-/**
- * FaasJS's http plugin.
- *
- * [![License: MIT](https://img.shields.io/npm/l/@faasjs/http.svg)](https://github.com/faasjs/faasjs/blob/main/packages/http/LICENSE)
- * [![NPM Version](https://img.shields.io/npm/v/@faasjs/http.svg)](https://www.npmjs.com/package/@faasjs/http)
- *
- * ## Install
- *
- * ```sh
- * npm install @faasjs/http
- * ```
- *
- * @packageDocumentation
- */
-
 declare const ContentType: {
     [key: string]: string;
 };
@@ -227,5 +213,33 @@ declare class Http<TParams extends Record<string, any> = any, TCookie extends Re
     setBody(body: string): Http<TParams, TCookie, TSession>;
 }
 declare function useHttp<TParams extends Record<string, any> = any, TCookie extends Record<string, string> = any, TSession extends Record<string, string> = any>(config?: HttpConfig<TParams, TCookie, TSession>): UseifyPlugin<Http<TParams, TCookie, TSession>>;
+type HttpFuncHandler<TParams extends Record<string, any> = Record<string, any>, TCookie extends Record<string, string> = Record<string, string>, TSession extends Record<string, any> = Record<string, any>, TResult = any> = (data: InvokeData<{
+    [key: string]: any;
+    params?: TParams;
+}> & {
+    params?: TParams;
+    cookie?: Cookie<TCookie, TSession>;
+    session?: Session<TSession, TCookie>;
+}) => Promise<TResult>;
+/**
+ * A hook to create an HTTP function with specified handler and configuration.
+ *
+ * @template TParams - The type of the parameters object.
+ * @template TCookie - The type of the cookies object.
+ * @template TSession - The type of the session object.
+ * @template TResult - The type of the result.
+ *
+ * @param {() => HttpFuncHandler<TParams, TCookie, TSession, TResult>} handler - The function handler to be used.
+ * @param {Object} [config] - Optional configuration object.
+ * @param {HttpConfig} [config.http] - Optional HTTP configuration.
+ *
+ * @returns {Function} The created HTTP function.
+ */
+declare function useHttpFunc<TParams extends Record<string, any> = Record<string, any>, TCookie extends Record<string, string> = Record<string, string>, TSession extends Record<string, any> = Record<string, any>, TResult = any>(handler: () => HttpFuncHandler<TParams, TCookie, TSession, TResult>, config?: {
+    http?: HttpConfig;
+}): _faasjs_func.Func<{
+    [key: string]: any;
+    params?: TParams;
+}, any, TResult>;
 
-export { ContentType, Cookie, type CookieOptions, Http, type HttpConfig, HttpError, type Response, Session, type SessionOptions, Validator, type ValidatorConfig, type ValidatorOptions, type ValidatorRuleOptions, useHttp };
+export { ContentType, Cookie, type CookieOptions, Http, type HttpConfig, HttpError, type HttpFuncHandler, type Response, Session, type SessionOptions, Validator, type ValidatorConfig, type ValidatorOptions, type ValidatorRuleOptions, useHttp, useHttpFunc };

package/dist/index.js

@@ -468,6 +468,7 @@ var Http = class {
       data.event.params = deepClone(this.params);
       data.logger.debug("Params: %j", this.params);
     }
+    data.params = data.event.params;
     this.cookie.invoke(this.headers.cookie, data.logger);
     if (this.headers.cookie) {
       data.logger.debug("Cookie: %j", this.cookie.content);
@@ -477,6 +478,8 @@ var Http = class {
         this.session.content
       );
     }
+    data.cookie = this.cookie;
+    data.session = this.session;
     try {
       if (this.validator) {
         data.logger.debug("Valid request");
@@ -588,6 +591,13 @@ var Http = class {
 function useHttp(config) {
   return func.usePlugin(new Http(config));
 }
+function useHttpFunc(handler, config) {
+  const func$1 = func.useFunc(() => {
+    useHttp(config?.http);
+    return handler();
+  });
+  return func$1;
+}
 
 exports.ContentType = ContentType;
 exports.Cookie = Cookie;
@@ -596,3 +606,4 @@ exports.HttpError = HttpError;
 exports.Session = Session;
 exports.Validator = Validator;
 exports.useHttp = useHttp;
+exports.useHttpFunc = useHttpFunc;

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { usePlugin } from '@faasjs/func';
+import { usePlugin, useFunc } from '@faasjs/func';
 import { deepMerge } from '@faasjs/deep_merge';
 import { randomBytes, pbkdf2Sync, createCipheriv, createHmac, createDecipheriv } from 'node:crypto';
 import { brotliCompressSync, gzipSync, deflateSync } from 'node:zlib';
@@ -466,6 +466,7 @@ var Http = class {
       data.event.params = deepClone(this.params);
       data.logger.debug("Params: %j", this.params);
     }
+    data.params = data.event.params;
     this.cookie.invoke(this.headers.cookie, data.logger);
     if (this.headers.cookie) {
       data.logger.debug("Cookie: %j", this.cookie.content);
@@ -475,6 +476,8 @@ var Http = class {
         this.session.content
       );
     }
+    data.cookie = this.cookie;
+    data.session = this.session;
     try {
       if (this.validator) {
         data.logger.debug("Valid request");
@@ -586,5 +589,12 @@ var Http = class {
 function useHttp(config) {
   return usePlugin(new Http(config));
 }
+function useHttpFunc(handler, config) {
+  const func = useFunc(() => {
+    useHttp(config?.http);
+    return handler();
+  });
+  return func;
+}
 
-export { ContentType, Cookie, Http, HttpError, Session, Validator, useHttp };
+export { ContentType, Cookie, Http, HttpError, Session, Validator, useHttp, useHttpFunc };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/http",
-  "version": "3.3.0",
+  "version": "3.5.0",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -34,12 +34,12 @@
     "dist"
   ],
   "peerDependencies": {
-    "@faasjs/func": "3.3.0",
-    "@faasjs/logger": "3.3.0"
+    "@faasjs/func": "3.5.0",
+    "@faasjs/logger": "3.5.0"
   },
   "devDependencies": {
-    "@faasjs/func": "3.3.0",
-    "@faasjs/logger": "3.3.0"
+    "@faasjs/func": "3.5.0",
+    "@faasjs/logger": "3.5.0"
   },
   "engines": {
     "node": ">=22.0.0",