mikroserve 0.0.1

package/lib/interfaces/index.d.mts

@@ -0,0 +1,264 @@
+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;
+    };
+    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;
+}
+/**
+ * Options when configuring any providers.
+ */
+type ProviderConfiguration = {
+    [providerType: string]: Record<string, any>;
+};
+/**
+ * Response utilities for handlers
+ */
+interface ResponseHelpers {
+    text(content: string, status?: number): HandlerResponse;
+    json(data: any, status?: number): HandlerResponse;
+    html(content: string, status?: number): HandlerResponse;
+    form(content: any, status?: number): HandlerResponse;
+    redirect(url: string, status?: 301 | 302 | 307 | 308): HandlerResponse;
+    status(code: number): ResponseHelpers;
+}
+/**
+ * Context object passed to route handlers
+ */
+interface Context extends ResponseHelpers {
+    req: http.IncomingMessage;
+    res: http.ServerResponse;
+    params: Record<string, string>;
+    query: Record<string, string>;
+    body: any;
+    headers: http.IncomingHttpHeaders;
+    path: string;
+    state: Record<string, any>;
+}
+/**
+ * Handler response object
+ */
+interface HandlerResponse {
+    statusCode: number;
+    body: any;
+    headers?: Record<string, string>;
+}
+/**
+ * Route handler function signature
+ */
+type RouteHandler = (context: Context) => Promise<HandlerResponse> | HandlerResponse;
+/**
+ * Middleware function signature
+ */
+type Middleware = (context: Context, next: () => Promise<HandlerResponse>) => Promise<HandlerResponse> | HandlerResponse;
+/**
+ * Route definition
+ */
+interface Route {
+    method: string;
+    path: string;
+    handler: RouteHandler;
+    middlewares: Middleware[];
+}
+/**
+ * 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;
+    encryptionKey?: string;
+    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 };

package/lib/interfaces/index.d.ts

@@ -0,0 +1,264 @@
+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;
+    };
+    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;
+}
+/**
+ * Options when configuring any providers.
+ */
+type ProviderConfiguration = {
+    [providerType: string]: Record<string, any>;
+};
+/**
+ * Response utilities for handlers
+ */
+interface ResponseHelpers {
+    text(content: string, status?: number): HandlerResponse;
+    json(data: any, status?: number): HandlerResponse;
+    html(content: string, status?: number): HandlerResponse;
+    form(content: any, status?: number): HandlerResponse;
+    redirect(url: string, status?: 301 | 302 | 307 | 308): HandlerResponse;
+    status(code: number): ResponseHelpers;
+}
+/**
+ * Context object passed to route handlers
+ */
+interface Context extends ResponseHelpers {
+    req: http.IncomingMessage;
+    res: http.ServerResponse;
+    params: Record<string, string>;
+    query: Record<string, string>;
+    body: any;
+    headers: http.IncomingHttpHeaders;
+    path: string;
+    state: Record<string, any>;
+}
+/**
+ * Handler response object
+ */
+interface HandlerResponse {
+    statusCode: number;
+    body: any;
+    headers?: Record<string, string>;
+}
+/**
+ * Route handler function signature
+ */
+type RouteHandler = (context: Context) => Promise<HandlerResponse> | HandlerResponse;
+/**
+ * Middleware function signature
+ */
+type Middleware = (context: Context, next: () => Promise<HandlerResponse>) => Promise<HandlerResponse> | HandlerResponse;
+/**
+ * Route definition
+ */
+interface Route {
+    method: string;
+    path: string;
+    handler: RouteHandler;
+    middlewares: Middleware[];
+}
+/**
+ * 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;
+    encryptionKey?: string;
+    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 };

package/lib/interfaces/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/interfaces/index.ts
+var interfaces_exports = {};
+module.exports = __toCommonJS(interfaces_exports);

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "mikroserve",
+  "description": "TODO",
+  "version": "0.0.1",
+  "author": "Mikael Vesavuori",
+  "license": "MIT",
+  "keywords": [],
+  "main": "lib/index.js",
+  "module": "lib/index.mjs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mikaelvesavuori/mikroserve"
+  },
+  "bugs": {
+    "url": "https://github.com/mikaelvesavuori/mikroserve/issues"
+  },
+  "homepage": "https://github.com/mikaelvesavuori/mikroserve",
+  "exports": {
+    ".": {
+      "require": "./lib/index.js",
+      "import": "./lib/index.mjs"
+    }
+  },
+  "files": [
+    "/lib",
+    "!/lib/**/*.map",
+    "!/tests"
+  ],
+  "bin": {
+    "mikroserve": "lib/index.js"
+  },
+  "scripts": {
+    "start": "npx tsx src/index.ts --force",
+    "test": "npm run test:licenses && npm run test:types && npm run lint && npm run test:unit",
+    "test:types": "npx type-coverage --at-least 85 --strict --ignore-files \"tests/**/*.ts\" --ignore-files \"*.ts\" --ignore-files \"src/application/errors/*.ts\" --ignore-files \"testdata/*.ts\"",
+    "test:licenses": "npx license-compliance --direct --allow 'MIT;ISC;0BSD;BSD-2-Clause;BSD-3-Clause;Apache-2.0;Unlicense;CC0-1.0'",
+    "test:unit": "npx vitest run --coverage",
+    "test:watch": "npx vitest --watch",
+    "build": "npm run clean && tsup src --format esm,cjs --dts && mv dist lib",
+    "clean": "rm -rf test-* && rm -rf mikroserve-demo && rm -rf lib",
+    "lint": "npx @biomejs/biome check --write ./src ./tests",
+    "package": "npm pack",
+    "prepublishOnly": "npm run build",
+    "prepare": "husky"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1",
+    "@types/node": "latest",
+    "@vitest/coverage-v8": "2",
+    "husky": "9",
+    "license-compliance": "latest",
+    "tsup": "8",
+    "tsx": "latest",
+    "type-coverage": "2",
+    "typescript": "5",
+    "vitest": "2"
+  }
+}