@expressots/core 2.9.0 → 2.10.0

package/lib/cjs/types/middleware/interfaces/cookie-session/cookie-session.interface.d.ts

@@ -1,57 +1,57 @@
-import { Keygrip } from "./keygrip.interface";
-interface CookieSessionOptions {
-    /**
-     * The name of the cookie to set, defaults to session.
-     */
-    name?: string | undefined;
-    /**
-     * The list of keys to use to sign & verify cookie values. Set cookies are always signed with keys[0], while the other keys are valid for verification, allowing for key rotation.
-     */
-    keys: Array<string> | Keygrip;
-    /**
-     * A string which will be used as single key if keys is not provided.
-     */
-    secret?: string | undefined;
-    /**
-     * a number representing the milliseconds from Date.now() for expiry.
-     */
-    maxAge?: number | undefined;
-    /**
-     * a Date object indicating the cookie's expiration date (expires at the end of session by default).
-     */
-    expires?: Date | undefined;
-    /**
-     * a string indicating the path of the cookie (/ by default).
-     */
-    path?: string | undefined;
-    /**
-     * a string indicating the domain of the cookie (no default).
-     */
-    domain?: string | undefined;
-    /**
-     * a boolean or string indicating whether the cookie is a "same site" cookie (false by default). This can be set to 'strict', 'lax', 'none', or true (which maps to 'strict').
-     */
-    sameSite?: "strict" | "lax" | "none" | boolean | undefined;
-    /**
-     * a boolean indicating whether the cookie is only to be sent over HTTPS (false by default for HTTP, true by default for HTTPS).
-     */
-    secure?: boolean | undefined;
-    /**
-     * a boolean indicating whether the cookie is only to be sent over HTTPS (use this if you handle SSL not in your node process).
-     */
-    secureProxy?: boolean | undefined;
-    /**
-     * a boolean indicating whether the cookie is only to be sent over HTTP(S), and not made available to client JavaScript (true by default).
-     */
-    httpOnly?: boolean | undefined;
-    /**
-     * a boolean indicating whether the cookie is to be signed (true by default). If this is true, another cookie of the same name with the .sig suffix appended will also be sent, with a 27-byte url-safe base64 SHA1 value representing the hash of cookie-name=cookie-value against the
-     * first Keygrip key. This signature key is used to detect tampering the next time a cookie is received.
-     */
-    signed?: boolean | undefined;
-    /**
-     * a boolean indicating whether to overwrite previously set cookies of the same name (true by default). If this is true, all cookies set during the same request with the same name (regardless of path or domain) are filtered out of the Set-Cookie header when setting this cookie.
-     */
-    overwrite?: boolean | undefined;
-}
-export { CookieSessionOptions };
+import { Keygrip } from "./keygrip.interface";
+interface CookieSessionOptions {
+    /**
+     * The name of the cookie to set, defaults to session.
+     */
+    name?: string | undefined;
+    /**
+     * The list of keys to use to sign & verify cookie values. Set cookies are always signed with keys[0], while the other keys are valid for verification, allowing for key rotation.
+     */
+    keys: Array<string> | Keygrip;
+    /**
+     * A string which will be used as single key if keys is not provided.
+     */
+    secret?: string | undefined;
+    /**
+     * a number representing the milliseconds from Date.now() for expiry.
+     */
+    maxAge?: number | undefined;
+    /**
+     * a Date object indicating the cookie's expiration date (expires at the end of session by default).
+     */
+    expires?: Date | undefined;
+    /**
+     * a string indicating the path of the cookie (/ by default).
+     */
+    path?: string | undefined;
+    /**
+     * a string indicating the domain of the cookie (no default).
+     */
+    domain?: string | undefined;
+    /**
+     * a boolean or string indicating whether the cookie is a "same site" cookie (false by default). This can be set to 'strict', 'lax', 'none', or true (which maps to 'strict').
+     */
+    sameSite?: "strict" | "lax" | "none" | boolean | undefined;
+    /**
+     * a boolean indicating whether the cookie is only to be sent over HTTPS (false by default for HTTP, true by default for HTTPS).
+     */
+    secure?: boolean | undefined;
+    /**
+     * a boolean indicating whether the cookie is only to be sent over HTTPS (use this if you handle SSL not in your node process).
+     */
+    secureProxy?: boolean | undefined;
+    /**
+     * a boolean indicating whether the cookie is only to be sent over HTTP(S), and not made available to client JavaScript (true by default).
+     */
+    httpOnly?: boolean | undefined;
+    /**
+     * a boolean indicating whether the cookie is to be signed (true by default). If this is true, another cookie of the same name with the .sig suffix appended will also be sent, with a 27-byte url-safe base64 SHA1 value representing the hash of cookie-name=cookie-value against the
+     * first Keygrip key. This signature key is used to detect tampering the next time a cookie is received.
+     */
+    signed?: boolean | undefined;
+    /**
+     * a boolean indicating whether to overwrite previously set cookies of the same name (true by default). If this is true, all cookies set during the same request with the same name (regardless of path or domain) are filtered out of the Set-Cookie header when setting this cookie.
+     */
+    overwrite?: boolean | undefined;
+}
+export { CookieSessionOptions };

package/lib/cjs/types/middleware/interfaces/cookie-session/keygrip.interface.d.ts

@@ -1,27 +1,27 @@
-interface Keygrip {
-    /**
-     * Signs the provided data and returns the signature as a string.
-     * @param data Data to be signed.
-     * @returns Signature string.
-     */
-    sign(data: any): string;
-    /**
-     * Verifies the provided data against a given digest (signature).
-     * @param data Data to be verified.
-     * @param digest Signature to verify against.
-     * @returns True if the verification is successful, otherwise false.
-     */
-    verify(data: any, digest: string): boolean;
-    /**
-     * Retrieves the index of the provided data in relation to a given digest (signature).
-     * @param data Data to find the index for.
-     * @param digest Signature to search for.
-     * @returns Index of the data, or -1 if not found.
-     */
-    index(data: any, digest: string): number;
-}
-interface KeygripFunction {
-    new (keys: ReadonlyArray<string>, algorithm?: string, encoding?: string): Keygrip;
-    (keys: ReadonlyArray<string>, algorithm?: string, encoding?: string): Keygrip;
-}
-export { KeygripFunction as Keygrip };
+interface Keygrip {
+    /**
+     * Signs the provided data and returns the signature as a string.
+     * @param data Data to be signed.
+     * @returns Signature string.
+     */
+    sign(data: any): string;
+    /**
+     * Verifies the provided data against a given digest (signature).
+     * @param data Data to be verified.
+     * @param digest Signature to verify against.
+     * @returns True if the verification is successful, otherwise false.
+     */
+    verify(data: any, digest: string): boolean;
+    /**
+     * Retrieves the index of the provided data in relation to a given digest (signature).
+     * @param data Data to find the index for.
+     * @param digest Signature to search for.
+     * @returns Index of the data, or -1 if not found.
+     */
+    index(data: any, digest: string): number;
+}
+interface KeygripFunction {
+    new (keys: ReadonlyArray<string>, algorithm?: string, encoding?: string): Keygrip;
+    (keys: ReadonlyArray<string>, algorithm?: string, encoding?: string): Keygrip;
+}
+export { KeygripFunction as Keygrip };

package/lib/cjs/types/middleware/interfaces/cors.interface.d.ts

@@ -1,57 +1,57 @@
-/**
- * Represents the possible values for the `origin` property in the `CorsOptions` interface.
- */
-type StaticOrigin = boolean | string | RegExp | (boolean | string | RegExp)[];
-/**
- * A function type to define a custom origin configuration in the `CorsOptions` interface.
- *
- * @param requestOrigin - The origin of the incoming request, or undefined if not available.
- * @param callback - A callback function to indicate whether the request origin is allowed or not.
- */
-type CustomOrigin = (requestOrigin: string | undefined, callback: (err: Error | null, origin?: StaticOrigin) => void) => void;
-/**
- * Interface to define Cross-Origin Resource Sharing (CORS) options.
- */
-interface CorsOptions {
-    /**
-     * Configures the Access-Control-Allow-Origin CORS header.
-     *
-     * @default '*' (allows requests from any origin)
-     */
-    origin?: StaticOrigin | CustomOrigin | undefined;
-    /**
-     * Configures the Access-Control-Allow-Methods CORS header.
-     *
-     * @default 'GET,HEAD,PUT,PATCH,POST,DELETE' (allows these HTTP methods)
-     */
-    methods?: string | Array<string> | undefined;
-    /**
-     * Configures the Access-Control-Allow-Headers CORS header.
-     */
-    allowedHeaders?: string | Array<string> | undefined;
-    /**
-     * Configures the Access-Control-Expose-Headers CORS header.
-     */
-    exposedHeaders?: string | Array<string> | undefined;
-    /**
-     * Configures the Access-Control-Allow-Credentials CORS header.
-     */
-    credentials?: boolean | undefined;
-    /**
-     * Configures the Access-Control-Max-Age CORS header.
-     */
-    maxAge?: number | undefined;
-    /**
-     * If true, allows preflight requests to pass to the next handler.
-     *
-     * @default false
-     */
-    preflightContinue?: boolean | undefined;
-    /**
-     * Defines the status code to be sent to the client on a successful OPTIONS request, as a part of the preflight request.
-     *
-     * @default 204
-     */
-    optionsSuccessStatus?: number | undefined;
-}
-export { CorsOptions };
+/**
+ * Represents the possible values for the `origin` property in the `CorsOptions` interface.
+ */
+type StaticOrigin = boolean | string | RegExp | (boolean | string | RegExp)[];
+/**
+ * A function type to define a custom origin configuration in the `CorsOptions` interface.
+ *
+ * @param requestOrigin - The origin of the incoming request, or undefined if not available.
+ * @param callback - A callback function to indicate whether the request origin is allowed or not.
+ */
+type CustomOrigin = (requestOrigin: string | undefined, callback: (err: Error | null, origin?: StaticOrigin) => void) => void;
+/**
+ * Interface to define Cross-Origin Resource Sharing (CORS) options.
+ */
+interface CorsOptions {
+    /**
+     * Configures the Access-Control-Allow-Origin CORS header.
+     *
+     * @default '*' (allows requests from any origin)
+     */
+    origin?: StaticOrigin | CustomOrigin | undefined;
+    /**
+     * Configures the Access-Control-Allow-Methods CORS header.
+     *
+     * @default 'GET,HEAD,PUT,PATCH,POST,DELETE' (allows these HTTP methods)
+     */
+    methods?: string | Array<string> | undefined;
+    /**
+     * Configures the Access-Control-Allow-Headers CORS header.
+     */
+    allowedHeaders?: string | Array<string> | undefined;
+    /**
+     * Configures the Access-Control-Expose-Headers CORS header.
+     */
+    exposedHeaders?: string | Array<string> | undefined;
+    /**
+     * Configures the Access-Control-Allow-Credentials CORS header.
+     */
+    credentials?: boolean | undefined;
+    /**
+     * Configures the Access-Control-Max-Age CORS header.
+     */
+    maxAge?: number | undefined;
+    /**
+     * If true, allows preflight requests to pass to the next handler.
+     *
+     * @default false
+     */
+    preflightContinue?: boolean | undefined;
+    /**
+     * Defines the status code to be sent to the client on a successful OPTIONS request, as a part of the preflight request.
+     *
+     * @default 204
+     */
+    optionsSuccessStatus?: number | undefined;
+}
+export { CorsOptions };