@arkstack/http 0.12.6 → 0.12.7

package/dist/{index-BfxuYaPt.d.ts → index-DM79pxEy.d.ts}

@@ -4,6 +4,11 @@ import * as _$kanun from "kanun";
 import { RequestData } from "clear-router/types/basic";
 
 //#region src/Response.d.ts
+/**
+ * Represents an HTTP response, providing a consistent interface for accessing response data.
+ *
+ * @author 3m1n3nc3
+ */
 declare class Response$1<TBody = unknown> extends Response {
   body: TBody;
   readonly source?: unknown;
@@ -164,27 +169,130 @@ declare class Session {
   private queuePersist;
   save(): Promise<this>;
   destroy(): Promise<this>;
+  /**
+   * Get an item from the session bag
+   *
+   * @param key
+   * @param defaultValue
+   * @returns
+   */
   get<T = any>(key: string, defaultValue?: T): T;
+  /**
+   * Add an item to the session bag
+   *
+   * @param key
+   * @param defaultValue
+   * @returns
+   */
   put<T = any>(key: string, value: T): this;
+  /**
+   * Add an item to the session bag
+   *
+   * @param key
+   * @param defaultValue
+   * @returns
+   */
   set<T = any>(key: string, value: T): this;
+  /**
+   * Check if an item exist in the session bag
+   *
+   * @param key
+   * @returns
+   */
   has(key: string): boolean;
+  /**
+   * Remove an item from the session bag
+   *
+   * @param key
+   * @returns
+   */
   forget(key: string): this;
+  /**
+   * Clear the session bag
+   *
+   * @returns
+   */
   clear(): this;
+  /**
+   * Get all items in the session bag
+   *
+   * @returns
+   */
   all(): {
     [x: string]: any;
   };
+  /**
+   * Add a flash item for the next request
+   *
+   * @param key
+   * @param value
+   * @returns
+   */
   flash<T = any>(key: string, value: T): this;
+  /**
+   * Get a flash item
+   *
+   * @param key
+   * @param defaultValue
+   * @returns
+   */
   getFlash<T = any>(key: string, defaultValue?: T): T;
+  /**
+   * Sweep flashed data that was loaded for this request
+   *
+   * @returns
+   */
   sweepFlash(): Promise<this>;
+  /**
+   * Add an error to the session error bag
+   *
+   * @param field
+   * @param message
+   * @returns
+   */
   addError(field: string, message: SessionErrorValue): this;
+  /**
+   * Add multiple errors to the session error bag
+   *
+   * @param errors
+   * @returns
+   */
   addErrors(errors: SessionErrorRecord | ErrorBag): this;
+  /**
+   * Add a validation error to the session error bag
+   *
+   * @param error
+   * @returns
+   */
   addValidationErrors(error: unknown): this;
+  /**
+   * Check if the session error bag has any errors
+   *
+   * @param field
+   * @returns
+   */
   hasErrors(field?: string): boolean;
+  /**
+   * Clear all errors in the session error bag
+   *
+   * @param field
+   * @returns
+   */
   clearErrors(field?: string): this;
+  /**
+   * Parse session for views
+   *
+   * @returns
+   */
   forView(): {
     errors: ErrorBag;
     flash: FlashBag<unknown>;
   };
+  /**
+   * Return session as json
+   *
+   * @returns
+   */
   toJSON(): {
     errors: Record<string, string[]>;
     flash: {
@@ -200,7 +308,20 @@ declare const kanunSessionPlugin: _$kanun.ValidatorPlugin;
 //#region src/session/helpers.d.ts
 declare const registerResponseFlashSweep: (target: unknown, session?: Session) => void;
 declare const attachViewState: (target: Record<PropertyKey, any>, session: Session) => void;
+/**
+ * Ensure a valid session exists
+ *
+ * @param ctx
+ * @param initial
+ * @returns
+ */
 declare const ensureSession: (ctx: unknown, initial?: SessionInitialState | Record<string, any>, persistent?: SessionDriverResult) => Session;
+/**
+ * Get the current session
+ *
+ * @param ctx
+ * @returns
+ */
 declare const getSession: (ctx: unknown) => Session | undefined;
 //#endregion
 //#region src/session/config.d.ts
@@ -325,6 +446,11 @@ interface OldHelper {
 }
 //#endregion
 //#region src/Request.d.ts
+/**
+ * Represents an HTTP request, providing a consistent interface for accessing request data.
+ *
+ * @author 3m1n3nc3
+ */
 declare class Request$1<TUser = unknown> extends Request {
   readonly headers: HeaderMap;
   readonly ip: string | null;

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 /// <reference path="./app.d.ts" />
-import { $ as ErrorBag, A as encodeSessionPayload, B as serializeCookie, C as ResponseSource, D as CookieSessionDriver, E as DatabaseSessionDriver, F as encodeJson, G as getSessionDriver, H as signValue, I as encodeSignedValue, J as getSession, K as attachViewState, L as generateSessionId, M as encryptSessionValue, N as decodeJson, O as BaseSessionDriver, P as decodeSignedValue, Q as Session, R as getCookie, S as RequestSource, T as FileSessionDriver, U as configureSession, V as setCookie, W as createSessionDriver, X as arkstackHttpPlugin, Y as registerResponseFlashSweep, Z as kanunSessionPlugin, _ as HeaderValue, a as redirect, at as SessionDriver, b as RequestHelper, c as isHeaders, ct as SessionErrorRecord, d as normalizeHeaderValue, dt as SessionInitialState, et as BaseSessionDriverOptions, f as normalizeHeaders, ft as SessionMessageProvider, g as HeaderSource, gt as Response, h as HeaderMap, ht as FlashBag, i as old, it as SessionConfig, j as decryptSessionValue, k as decodeSessionPayload, l as isRecord, lt as SessionErrorSource, m as Request, mt as cookie_options, n as web, nt as HttpContextLike, o as redirectBackTarget, ot as SessionDriverResult, p as unwrapRequestSource, pt as SessionPayload, q as ensureSession, r as webMiddlewareKey, rt as PersistentSessionConfig, s as resolveRedirectTarget, st as SessionDriverType, t as isWebRequest, tt as DatabaseSessionDriverOptions, u as makeHeaders, ut as SessionErrorValue, v as OldHelper, w as SessionHelper, x as RequestOptions, y as RedirectHelper, z as parseCookies } from "./index-BfxuYaPt.js";
+import { $ as ErrorBag, A as encodeSessionPayload, B as serializeCookie, C as ResponseSource, D as CookieSessionDriver, E as DatabaseSessionDriver, F as encodeJson, G as getSessionDriver, H as signValue, I as encodeSignedValue, J as getSession, K as attachViewState, L as generateSessionId, M as encryptSessionValue, N as decodeJson, O as BaseSessionDriver, P as decodeSignedValue, Q as Session, R as getCookie, S as RequestSource, T as FileSessionDriver, U as configureSession, V as setCookie, W as createSessionDriver, X as arkstackHttpPlugin, Y as registerResponseFlashSweep, Z as kanunSessionPlugin, _ as HeaderValue, a as redirect, at as SessionDriver, b as RequestHelper, c as isHeaders, ct as SessionErrorRecord, d as normalizeHeaderValue, dt as SessionInitialState, et as BaseSessionDriverOptions, f as normalizeHeaders, ft as SessionMessageProvider, g as HeaderSource, gt as Response, h as HeaderMap, ht as FlashBag, i as old, it as SessionConfig, j as decryptSessionValue, k as decodeSessionPayload, l as isRecord, lt as SessionErrorSource, m as Request, mt as cookie_options, n as web, nt as HttpContextLike, o as redirectBackTarget, ot as SessionDriverResult, p as unwrapRequestSource, pt as SessionPayload, q as ensureSession, r as webMiddlewareKey, rt as PersistentSessionConfig, s as resolveRedirectTarget, st as SessionDriverType, t as isWebRequest, tt as DatabaseSessionDriverOptions, u as makeHeaders, ut as SessionErrorValue, v as OldHelper, w as SessionHelper, x as RequestOptions, y as RedirectHelper, z as parseCookies } from "./index-DM79pxEy.js";
 export { BaseSessionDriver, BaseSessionDriverOptions, CookieSessionDriver, DatabaseSessionDriver, DatabaseSessionDriverOptions, ErrorBag, FileSessionDriver, FlashBag, HeaderMap, HeaderSource, HeaderValue, HttpContextLike, OldHelper, PersistentSessionConfig, RedirectHelper, Request, RequestHelper, RequestOptions, RequestSource, Response, ResponseSource, Session, SessionConfig, SessionDriver, SessionDriverResult, SessionDriverType, SessionErrorRecord, SessionErrorSource, SessionErrorValue, SessionHelper, SessionInitialState, SessionMessageProvider, SessionPayload, arkstackHttpPlugin, attachViewState, configureSession, cookie_options, createSessionDriver, decodeJson, decodeSessionPayload, decodeSignedValue, decryptSessionValue, encodeJson, encodeSessionPayload, encodeSignedValue, encryptSessionValue, ensureSession, generateSessionId, getCookie, getSession, getSessionDriver, isHeaders, isRecord, isWebRequest, kanunSessionPlugin, makeHeaders, normalizeHeaderValue, normalizeHeaders, old, parseCookies, redirect, redirectBackTarget, registerResponseFlashSweep, resolveRedirectTarget, serializeCookie, setCookie, signValue, unwrapRequestSource, web, webMiddlewareKey };

package/dist/setup.d.ts

@@ -1,5 +1,4 @@
-import { b as RequestHelper, gt as Response, v as OldHelper, w as SessionHelper, y as RedirectHelper } from "./index-BfxuYaPt.js";
-
+import { b as RequestHelper, gt as Response, v as OldHelper, w as SessionHelper, y as RedirectHelper } from "./index-DM79pxEy.js";
 //#region src/setup.d.ts
 declare global {
   var session: SessionHelper;

package/dist/setup.js

@@ -1,6 +1,7 @@
 import { F as Response$1, I as Request$1, a as kanunSessionPlugin, i as arkstackHttpPlugin, j as old, t as redirect } from "./redirect-Bt3re8Qq.js";
 import { CoreRouter } from "clear-router";
 import { Validator } from "kanun";
+import "dotenv/config";
 //#region src/setup.ts
 CoreRouter.setRequestProvider(Request$1);
 CoreRouter.setResponseProvider(Response$1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/http",
-  "version": "0.12.6",
+  "version": "0.12.7",
   "type": "module",
   "description": "HTTP module for Arkstack, providing framework-agnostic request and response primitives.",
   "homepage": "https://arkstack.toneflix.net/guide/http",
@@ -29,7 +29,8 @@
   },
   "dependencies": {
     "clear-router": "^2.8.0",
-    "@arkstack/contract": "^0.12.6"
+    "dotenv": "17.3.1",
+    "@arkstack/contract": "^0.12.7"
   },
   "peerDependencies": {
     "arkormx": "^2.4.1",