@monocloud/auth-node-core 0.1.6 → 0.1.7

package/dist/index.d.mts

@@ -14,7 +14,11 @@ interface CookieOptions extends SerializeOptions$1 {}
  * @category Types
  */
 interface IMonoCloudCookieRequest {
-  /** Retrieves a single cookie value by name. */
+  /**
+   * Retrieves a single cookie value by name.
+   *
+   * @param name - The name of the cookie to retrieve.
+   */
   getCookie(name: string): Promise<string | undefined>;
   /** Retrieves all cookies from the request. */
   getAllCookies(): Promise<Map<string, string>>;
@@ -25,7 +29,11 @@ interface IMonoCloudCookieRequest {
  * @category Types
  */
 interface MonoCloudRequest extends IMonoCloudCookieRequest {
-  /** Retrieves a query parameter value by name. */
+  /**
+   * Retrieves a query parameter value by name.
+   *
+   * @param parameter - The name of the query parameter to retrieve.
+   */
   getQuery(parameter: string): string | string[] | undefined;
   /** Returns the raw request details including method, URL, and body. */
   getRawRequest(): Promise<{
@@ -40,7 +48,13 @@ interface MonoCloudRequest extends IMonoCloudCookieRequest {
  * @category Types
  */
 interface IMonoCloudCookieResponse {
-  /** Sets a cookie on the response. */
+  /**
+   * Sets a cookie on the response.
+   *
+   * @param cookieName - The name of the cookie to set.
+   * @param value - The value to assign to the cookie.
+   * @param options - Serialization options for the cookie.
+   */
   setCookie(cookieName: string, value: string, options: CookieOptions): Promise<void>;
 }
 /**
@@ -49,9 +63,19 @@ interface IMonoCloudCookieResponse {
  * @category Types
  */
 interface MonoCloudResponse extends IMonoCloudCookieResponse {
-  /** Redirects the client to the specified URL. */
+  /**
+   * Redirects the client to the specified URL.
+   *
+   * @param url - The URL to redirect to.
+   * @param statusCode - The HTTP status code to use for the redirect.
+   */
   redirect(url: string, statusCode?: number): void;
-  /** Sends a JSON response with an optional status code. */
+  /**
+   * Sends a JSON response with an optional status code.
+   *
+   * @param data - The data to serialize and send as JSON.
+   * @param statusCode - The HTTP status code for the response.
+   */
   sendJson(data: any, statusCode?: number): void;
   /** Sends a 404 Not Found response. */
   notFound(): void;
@@ -166,10 +190,7 @@ interface MonoCloudSessionStore {
  */
 interface MonoCloudCookieOptions {
   /**
-   * The cookie name.
-   *
-   * - Session cookie default: `"session"`
-   * - State cookie default: `"state"`
+   * The cookie name. Defaults to `"session"` for session cookies and `"state"` for state cookies.
    */
   name: string;
   /**
@@ -185,7 +206,7 @@ interface MonoCloudCookieOptions {
   /**
    * Indicates whether the cookie is accessible only via HTTP requests. Helps mitigate XSS attacks by preventing client-side JavaScript access.
    *
-   * > Always enforced as `true` for state cookies.
+   * Always enforced as `true` for state cookies.
    *
    * @defaultValue true
    */
@@ -204,9 +225,7 @@ interface MonoCloudCookieOptions {
   sameSite: SameSiteValues;
   /**
    * Determines whether the cookie persists across browser restarts.
-   *
-   * - Session cookies default to `true`
-   * - State cookies default to `false`
+   * Defaults to `true` for session cookies and `false` for state cookies.
    */
   persistent: boolean;
 }
@@ -235,8 +254,8 @@ interface MonoCloudSessionOptionsBase {
   /**
    * The session lifetime in seconds.
    *
-   * - With **absolute sessions** (`sliding = false`), this defines the total session lifetime.
-   * - With **sliding sessions**, this defines the idle timeout before the session expires.
+   * With **absolute sessions** (`sliding = false`), this defines the total session lifetime.
+   * With **sliding sessions**, this defines the idle timeout before the session expires.
    *
    * @defaultValue 86400 (1 Day)
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monocloud/auth-node-core",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "MonoCloud NodeJS Authentication Core SDK",
   "keywords": [
     "monocloud",
@@ -56,7 +56,7 @@
     "joi": "18.0.2",
     "jose": "6.1.3",
     "uuid": "13.0.0",
-    "@monocloud/auth-core": "0.1.5"
+    "@monocloud/auth-core": "0.1.6"
   },
   "devDependencies": {
     "@types/debug": "4.1.12",