mikroserve 0.0.2 → 0.0.4

package/lib/interfaces/index.d.mts

@@ -1,193 +1,74 @@
 import http from 'node:http';
 
 /**
- * @description Storage interface for MikroAuth.
- */
-interface StorageProvider {
-    set(key: string, value: string, expirySeconds?: number): Promise<void>;
-    get(key: string): Promise<string | null>;
-    delete(key: string): Promise<void>;
-    addToCollection(collectionKey: string, item: string, expirySeconds?: number): Promise<void>;
-    removeFromCollection(collectionKey: string, item: string): Promise<void>;
-    getCollection(collectionKey: string): Promise<string[]>;
-    getCollectionSize(collectionKey: string): Promise<number>;
-    removeOldestFromCollection(collectionKey: string): Promise<string | null>;
-    findKeys(pattern: string): Promise<string[]>;
-}
-interface EmailMessage {
-    from: string;
-    to: string;
-    subject: string;
-    text: string;
-    html: string;
-}
-interface EmailProvider {
-    sendMail(message: EmailMessage): Promise<void>;
-}
-interface JwtHeader {
-    alg: string;
-    typ: string;
-}
-interface JwtClaims {
-    iss?: string;
-    sub?: string;
-    aud?: string;
-    exp?: number;
-    nbf?: number;
-    iat?: number;
-    jti?: string;
-    [key: string]: any;
-}
-interface JwtSignOptions {
-    expiresIn?: number;
-    notBefore?: number;
-    issuer?: string;
-    audience?: string;
-    subject?: string;
-    jwtid?: string;
-}
-interface JwtVerifyOptions {
-    issuer?: string;
-    audience?: string;
-    subject?: string;
-    clockTolerance?: number;
-}
-interface DecodedJwt {
-    header: JwtHeader;
-    payload: JwtClaims;
-    signature: string;
-}
-interface JwtPayload {
-    sub: string;
-    jti: string;
-    iat?: number;
-    exp?: number;
-    lastLogin: number;
-    metadata?: {
-        ip?: string;
-    };
-}
-/**
- * JWT payload structure
- */
-interface JwtPayload {
-    sub: string;
-    jti: string;
-    iat?: number;
-    exp?: number;
-    lastLogin: number;
-    metadata?: {
-        ip?: string;
-    };
-}
-interface RequestContext {
-    body?: Record<string, any>;
-    query?: Record<string, any>;
-    headers?: Record<string, any>;
-    ip?: string;
-    log?: {
-        error: (message: string, error: Error) => void;
-        info?: (message: string, ...args: any[]) => void;
-    };
-    user?: {
-        email: string;
-    };
-}
-/**
- * Request context interface
- */
-interface RequestContext {
-    body?: Record<string, any>;
-    query?: Record<string, any>;
-    headers?: Record<string, any>;
-    ip?: string;
-    log?: {
-        error: (message: string, error: Error) => void;
-        info?: (message: string, ...args: any[]) => void;
-    };
-    user?: {
-        email: string;
-    };
-}
-interface MagicLinkRequest {
-    email: string;
-    ip?: string;
-}
-/**
- * Magic link request parameters
- */
-interface MagicLinkRequest {
-    email: string;
-    ip?: string;
-}
-interface MagicLinkUrlParams {
-    token: string;
-    email: string;
-}
-/**
- * Parameters for creating a magic link URL
- */
-interface MagicLinkUrlParams {
-    token: string;
-    email: string;
-}
-interface VerifyTokenRequest {
-    token: string;
-    email: string;
-}
-/**
- * Verify token request parameters
- */
-interface VerifyTokenRequest {
-    token: string;
-    email: string;
-}
-interface SessionInfo {
-    id: string;
-    createdAt: number;
-    lastLogin: number;
-    lastUsed?: number;
-    metadata?: {
-        ip?: string;
-    };
-    isCurrentSession?: boolean;
-}
-/**
- * Session information interface
- */
-interface SessionInfo {
-    id: string;
-    createdAt: number;
-    lastLogin: number;
-    lastUsed?: number;
-    metadata?: {
-        ip?: string;
+ * @description Server configuration options.
+ */
+type MikroServeConfiguration = {
+    /**
+     * The port to expose.
+     * @default process.env.PORT
+     * @default 3000
+     */
+    port: number;
+    /**
+     * The host name to use.
+     * @default process.env.HOST
+     * @default '0.0.0.0'
+     */
+    host: string;
+    /**
+     * Should the server use HTTPS?
+     * @default false
+     */
+    useHttps: boolean;
+    /**
+     * The path to the SSL certificate.
+     * @default '''
+     */
+    sslCert: string;
+    /**
+     * The path to the SSL key.
+     * @default ''
+     */
+    sslKey: string;
+    /**
+     * The path to the SSL CA file.
+     * @default ''
+     */
+    sslCa: string;
+    /**
+     * Use debug mode?
+     * @default process.env.DEBUG
+     * @default false
+     */
+    debug: boolean;
+    /**
+     * Rate limiter settings.
+     */
+    rateLimit: {
+        /**
+         * Should the rate limiter be active?
+         * @default true
+         */
+        enabled: boolean;
+        /**
+         * What is the maximum requests per minute from a given IP address?
+         * @default 100
+         */
+        requestsPerMinute: number;
     };
-    isCurrentSession?: boolean;
-}
-interface TokenResponse {
-    accessToken: string;
-    refreshToken: string;
-    expiresIn: number;
-    tokenType: string;
-}
-/**
- * Token response interface
- */
-interface TokenResponse {
-    accessToken: string;
-    refreshToken: string;
-    expiresIn: number;
-    tokenType: string;
-}
+    /**
+     * List of allowed domains.
+     * @default ["*"]
+     */
+    allowedDomains: string[];
+};
 /**
- * Options when configuring any providers.
+ * @description Server configuration options.
  */
-type ProviderConfiguration = {
-    [providerType: string]: Record<string, any>;
-};
+type MikroServeOptions = Partial<MikroServeConfiguration>;
 /**
- * Response utilities for handlers
+ * @description Response utilities for handlers.
  */
 interface ResponseHelpers {
     text(content: string, status?: number): HandlerResponse;
@@ -198,7 +79,7 @@ interface ResponseHelpers {
     status(code: number): ResponseHelpers;
 }
 /**
- * Context object passed to route handlers
+ * @description Context object passed to route handlers.
  */
 interface Context extends ResponseHelpers {
     req: http.IncomingMessage;
@@ -211,7 +92,7 @@ interface Context extends ResponseHelpers {
     state: Record<string, any>;
 }
 /**
- * Handler response object
+ * @description Handler response object.
  */
 interface HandlerResponse {
     statusCode: number;
@@ -219,15 +100,15 @@ interface HandlerResponse {
     headers?: Record<string, string>;
 }
 /**
- * Route handler function signature
+ * @description Route handler function signature.
  */
 type RouteHandler = (context: Context) => Promise<HandlerResponse> | HandlerResponse;
 /**
- * Middleware function signature
+ * @description Middleware function signature.
  */
 type Middleware = (context: Context, next: () => Promise<HandlerResponse>) => Promise<HandlerResponse> | HandlerResponse;
 /**
- * Route definition
+ * @description Route definition.
  */
 interface Route {
     method: string;
@@ -236,28 +117,11 @@ interface Route {
     middlewares: Middleware[];
 }
 /**
- * Path pattern parameter extraction
+ * @description Path pattern parameter extraction.
  */
 interface PathPattern {
     pattern: RegExp;
     paramNames: string[];
 }
-/**
- * Server configuration options
- */
-interface MikroServeConfiguration {
-    port?: number;
-    host?: string;
-    useHttps?: boolean;
-    sslCert?: string;
-    sslKey?: string;
-    sslCa?: string;
-    debug?: boolean;
-    rateLimit?: {
-        requestsPerMinute: number;
-        enabled: boolean;
-    };
-    allowedDomains?: string[];
-}
 
-export type { Context, DecodedJwt, EmailMessage, EmailProvider, HandlerResponse, JwtClaims, JwtHeader, JwtPayload, JwtSignOptions, JwtVerifyOptions, MagicLinkRequest, MagicLinkUrlParams, Middleware, MikroServeConfiguration, PathPattern, ProviderConfiguration, RequestContext, ResponseHelpers, Route, RouteHandler, SessionInfo, StorageProvider, TokenResponse, VerifyTokenRequest };
+export type { Context, HandlerResponse, Middleware, MikroServeConfiguration, MikroServeOptions, PathPattern, ResponseHelpers, Route, RouteHandler };

package/lib/interfaces/index.d.ts

@@ -1,193 +1,74 @@
 import http from 'node:http';
 
 /**
- * @description Storage interface for MikroAuth.
- */
-interface StorageProvider {
-    set(key: string, value: string, expirySeconds?: number): Promise<void>;
-    get(key: string): Promise<string | null>;
-    delete(key: string): Promise<void>;
-    addToCollection(collectionKey: string, item: string, expirySeconds?: number): Promise<void>;
-    removeFromCollection(collectionKey: string, item: string): Promise<void>;
-    getCollection(collectionKey: string): Promise<string[]>;
-    getCollectionSize(collectionKey: string): Promise<number>;
-    removeOldestFromCollection(collectionKey: string): Promise<string | null>;
-    findKeys(pattern: string): Promise<string[]>;
-}
-interface EmailMessage {
-    from: string;
-    to: string;
-    subject: string;
-    text: string;
-    html: string;
-}
-interface EmailProvider {
-    sendMail(message: EmailMessage): Promise<void>;
-}
-interface JwtHeader {
-    alg: string;
-    typ: string;
-}
-interface JwtClaims {
-    iss?: string;
-    sub?: string;
-    aud?: string;
-    exp?: number;
-    nbf?: number;
-    iat?: number;
-    jti?: string;
-    [key: string]: any;
-}
-interface JwtSignOptions {
-    expiresIn?: number;
-    notBefore?: number;
-    issuer?: string;
-    audience?: string;
-    subject?: string;
-    jwtid?: string;
-}
-interface JwtVerifyOptions {
-    issuer?: string;
-    audience?: string;
-    subject?: string;
-    clockTolerance?: number;
-}
-interface DecodedJwt {
-    header: JwtHeader;
-    payload: JwtClaims;
-    signature: string;
-}
-interface JwtPayload {
-    sub: string;
-    jti: string;
-    iat?: number;
-    exp?: number;
-    lastLogin: number;
-    metadata?: {
-        ip?: string;
-    };
-}
-/**
- * JWT payload structure
- */
-interface JwtPayload {
-    sub: string;
-    jti: string;
-    iat?: number;
-    exp?: number;
-    lastLogin: number;
-    metadata?: {
-        ip?: string;
-    };
-}
-interface RequestContext {
-    body?: Record<string, any>;
-    query?: Record<string, any>;
-    headers?: Record<string, any>;
-    ip?: string;
-    log?: {
-        error: (message: string, error: Error) => void;
-        info?: (message: string, ...args: any[]) => void;
-    };
-    user?: {
-        email: string;
-    };
-}
-/**
- * Request context interface
- */
-interface RequestContext {
-    body?: Record<string, any>;
-    query?: Record<string, any>;
-    headers?: Record<string, any>;
-    ip?: string;
-    log?: {
-        error: (message: string, error: Error) => void;
-        info?: (message: string, ...args: any[]) => void;
-    };
-    user?: {
-        email: string;
-    };
-}
-interface MagicLinkRequest {
-    email: string;
-    ip?: string;
-}
-/**
- * Magic link request parameters
- */
-interface MagicLinkRequest {
-    email: string;
-    ip?: string;
-}
-interface MagicLinkUrlParams {
-    token: string;
-    email: string;
-}
-/**
- * Parameters for creating a magic link URL
- */
-interface MagicLinkUrlParams {
-    token: string;
-    email: string;
-}
-interface VerifyTokenRequest {
-    token: string;
-    email: string;
-}
-/**
- * Verify token request parameters
- */
-interface VerifyTokenRequest {
-    token: string;
-    email: string;
-}
-interface SessionInfo {
-    id: string;
-    createdAt: number;
-    lastLogin: number;
-    lastUsed?: number;
-    metadata?: {
-        ip?: string;
-    };
-    isCurrentSession?: boolean;
-}
-/**
- * Session information interface
- */
-interface SessionInfo {
-    id: string;
-    createdAt: number;
-    lastLogin: number;
-    lastUsed?: number;
-    metadata?: {
-        ip?: string;
+ * @description Server configuration options.
+ */
+type MikroServeConfiguration = {
+    /**
+     * The port to expose.
+     * @default process.env.PORT
+     * @default 3000
+     */
+    port: number;
+    /**
+     * The host name to use.
+     * @default process.env.HOST
+     * @default '0.0.0.0'
+     */
+    host: string;
+    /**
+     * Should the server use HTTPS?
+     * @default false
+     */
+    useHttps: boolean;
+    /**
+     * The path to the SSL certificate.
+     * @default '''
+     */
+    sslCert: string;
+    /**
+     * The path to the SSL key.
+     * @default ''
+     */
+    sslKey: string;
+    /**
+     * The path to the SSL CA file.
+     * @default ''
+     */
+    sslCa: string;
+    /**
+     * Use debug mode?
+     * @default process.env.DEBUG
+     * @default false
+     */
+    debug: boolean;
+    /**
+     * Rate limiter settings.
+     */
+    rateLimit: {
+        /**
+         * Should the rate limiter be active?
+         * @default true
+         */
+        enabled: boolean;
+        /**
+         * What is the maximum requests per minute from a given IP address?
+         * @default 100
+         */
+        requestsPerMinute: number;
     };
-    isCurrentSession?: boolean;
-}
-interface TokenResponse {
-    accessToken: string;
-    refreshToken: string;
-    expiresIn: number;
-    tokenType: string;
-}
-/**
- * Token response interface
- */
-interface TokenResponse {
-    accessToken: string;
-    refreshToken: string;
-    expiresIn: number;
-    tokenType: string;
-}
+    /**
+     * List of allowed domains.
+     * @default ["*"]
+     */
+    allowedDomains: string[];
+};
 /**
- * Options when configuring any providers.
+ * @description Server configuration options.
  */
-type ProviderConfiguration = {
-    [providerType: string]: Record<string, any>;
-};
+type MikroServeOptions = Partial<MikroServeConfiguration>;
 /**
- * Response utilities for handlers
+ * @description Response utilities for handlers.
  */
 interface ResponseHelpers {
     text(content: string, status?: number): HandlerResponse;
@@ -198,7 +79,7 @@ interface ResponseHelpers {
     status(code: number): ResponseHelpers;
 }
 /**
- * Context object passed to route handlers
+ * @description Context object passed to route handlers.
  */
 interface Context extends ResponseHelpers {
     req: http.IncomingMessage;
@@ -211,7 +92,7 @@ interface Context extends ResponseHelpers {
     state: Record<string, any>;
 }
 /**
- * Handler response object
+ * @description Handler response object.
  */
 interface HandlerResponse {
     statusCode: number;
@@ -219,15 +100,15 @@ interface HandlerResponse {
     headers?: Record<string, string>;
 }
 /**
- * Route handler function signature
+ * @description Route handler function signature.
  */
 type RouteHandler = (context: Context) => Promise<HandlerResponse> | HandlerResponse;
 /**
- * Middleware function signature
+ * @description Middleware function signature.
  */
 type Middleware = (context: Context, next: () => Promise<HandlerResponse>) => Promise<HandlerResponse> | HandlerResponse;
 /**
- * Route definition
+ * @description Route definition.
  */
 interface Route {
     method: string;
@@ -236,28 +117,11 @@ interface Route {
     middlewares: Middleware[];
 }
 /**
- * Path pattern parameter extraction
+ * @description Path pattern parameter extraction.
  */
 interface PathPattern {
     pattern: RegExp;
     paramNames: string[];
 }
-/**
- * Server configuration options
- */
-interface MikroServeConfiguration {
-    port?: number;
-    host?: string;
-    useHttps?: boolean;
-    sslCert?: string;
-    sslKey?: string;
-    sslCa?: string;
-    debug?: boolean;
-    rateLimit?: {
-        requestsPerMinute: number;
-        enabled: boolean;
-    };
-    allowedDomains?: string[];
-}
 
-export type { Context, DecodedJwt, EmailMessage, EmailProvider, HandlerResponse, JwtClaims, JwtHeader, JwtPayload, JwtSignOptions, JwtVerifyOptions, MagicLinkRequest, MagicLinkUrlParams, Middleware, MikroServeConfiguration, PathPattern, ProviderConfiguration, RequestContext, ResponseHelpers, Route, RouteHandler, SessionInfo, StorageProvider, TokenResponse, VerifyTokenRequest };
+export type { Context, HandlerResponse, Middleware, MikroServeConfiguration, MikroServeOptions, PathPattern, ResponseHelpers, Route, RouteHandler };

package/lib/utils/configDefaults.d.mts

@@ -0,0 +1,20 @@
+import { MikroServeConfiguration } from '../interfaces/index.mjs';
+import 'node:http';
+
+declare const configDefaults: () => MikroServeConfiguration;
+declare const getDefaultConfig: () => {
+    port: number;
+    host: string;
+    useHttps: boolean;
+    sslCert: string;
+    sslKey: string;
+    sslCa: string;
+    debug: boolean;
+    rateLimit: {
+        enabled: boolean;
+        requestsPerMinute: number;
+    };
+    allowedDomains: string[];
+};
+
+export { configDefaults, getDefaultConfig };

package/lib/utils/configDefaults.d.ts

@@ -0,0 +1,20 @@
+import { MikroServeConfiguration } from '../interfaces/index.js';
+import 'node:http';
+
+declare const configDefaults: () => MikroServeConfiguration;
+declare const getDefaultConfig: () => {
+    port: number;
+    host: string;
+    useHttps: boolean;
+    sslCert: string;
+    sslKey: string;
+    sslCa: string;
+    debug: boolean;
+    rateLimit: {
+        enabled: boolean;
+        requestsPerMinute: number;
+    };
+    allowedDomains: string[];
+};
+
+export { configDefaults, getDefaultConfig };