miqro 6.1.4 → 6.2.0

package/src/types/miqro.d.ts

@@ -1,7 +1,10 @@
 import "./globals.js";
 import { Database, Migration } from "@miqro/query/lib.js";
+import { ReadBuffer, URLEncodedParser, JSONParser, TextParser, CORS, SessionHandler } from "@miqro/core/lib.js";
 import { ErrorHandler, HandlerWithOptions, CORSOptions, LogLevel, LoggerTransportWriteArgs, Request, Response, WebSocketServer, Logger, WebSocketServerOptions, SessionHandlerOptions, RouteOptions, Handler } from "@miqro/core/lib.js";
-import { ParserInterface } from "@miqro/parser/lib.js";
+import { Parser, ParserInterface } from "@miqro/parser/lib.js";
+import { ProtectedHeaderParameters, EncryptOptions, SignOptions, JWTPayload, JWTDecryptOptions, JWTDecryptResult, JWTVerifyResult, JWTVerifyOptions } from "jose/types/index.js";
+import { KeyObject } from "node:crypto";
 
 /*export * from "@miqro/core/lib.js";
 export * from "@miqro/query/lib.js";*/
@@ -10,6 +13,93 @@ export interface AuthConfig extends SessionHandlerOptions {
 
 }
 
+export interface EncryptJWTOptions {
+  alg?: string;
+  enc?: string;
+  iat?: number | string | Date;
+  iss?: string;
+  aud?: string;
+  exp?: number | string | Date;
+  options?: EncryptOptions;
+}
+
+export interface JWTSignOptions {
+  alg?: string;
+  iat?: number | string | Date;
+  iss?: string;
+  aud?: string;
+  exp?: number | string | Date;
+  options?: SignOptions;
+}
+
+export interface ServerGlobal {
+  encodeHTML: (str: string) => string;
+  inflateMDtoHTML: (str: string) => string;
+  middleware: {
+    buffer: typeof ReadBuffer;
+    url: typeof URLEncodedParser;
+    json: typeof JSONParser;
+    text: typeof TextParser;
+    cors: typeof CORS;
+    session: typeof SessionHandler;
+  };
+  newParser(): Parser;
+  newClusterCache: (name: string, logger?: Logger) => CacheInterface;
+  newLocalCache: (name: string, logger?: Logger) => CacheInterface;
+  createSecretKey: (key: string, encoding: BufferEncoding) => KeyObject;
+  getWorkerCount: () => number;
+  getWorkerNumber: () => number;
+  isPrimaryWorker: () => boolean;
+  jwt: {
+    /**
+   * creates a JWT encrypted token with jose
+   * 
+   * @param payload the payload to encrypt
+   * @param secret the secret example. const secret = createSecretKey(process.env.JWT_SECRET, 'utf-8');
+   * @param options options like expiratation date, issuer and audience
+   * @returns 
+   */
+    encrypt: (payload: JWTPayload, secret: KeyObject, options?: Partial<EncryptJWTOptions>) => Promise<string>
+    /**
+     * decrypts a JWT token with jose
+     * @param jwt the JWT token
+     * @param secret the secret example. const secret = createSecretKey(process.env.JWT_SECRET, 'utf-8');
+     * @param options options like issuer and audience
+     * @returns 
+     */
+    decrypt: <PayloadType = JWTPayload>(jwt: string, secret: KeyObject, options?: Partial<JWTDecryptOptions>) => Promise<JWTDecryptResult<PayloadType>>;
+    /**
+     * verify a JWT token with jose
+     * @param jwt the JWT token
+     * @param secret the secret example. const secret = createSecretKey(process.env.JWT_SECRET, 'utf-8');
+     * @param options options like issuer and audience
+     * @returns 
+     */
+    verify: <PayloadType = JWTPayload>(jwt: string, secret: KeyObject, options?: Partial<JWTVerifyOptions>) => Promise<JWTVerifyResult<PayloadType>>;
+    /**
+     * creates a signed JWT with jose
+     * 
+     * @param payload the payload to encrypt
+     * @param secret the secret example. const secret = createSecretKey(process.env.JWT_SECRET, 'utf-8');
+     * @param options options like expiratation date, issuer and audience
+     * @returns 
+     */
+    sign: (payload: JWTPayload, secret: KeyObject, options?: Partial<JWTSignOptions>) => Promise<string>;
+    /**
+     * decodes a protected header with jose
+     * @param token 
+     * @returns 
+     */
+    decodeProtectedHeader: (token: string | object) => ProtectedHeaderParameters;
+    /**
+     * decodes a jwt token
+     * @param jwt 
+     * @returns 
+     */
+    decode: <PayloadType = JWTPayload>(jwt: string) => PayloadType & JWTPayload;
+  }
+}
+
 export interface MiddlewareConfig {
   middleware?: Array<HandlerWithOptions | Handler>;
   post?: Array<HandlerWithOptions | Handler>;
@@ -97,7 +187,7 @@ export interface MigrateOptions {
   name?: string;
 }
 
-export interface ServerInterface {
+export interface ServerInterface extends ServerGlobal{
   // null values are if the feature has been disabled
   db: {
     get(name: string): Database | null;

package/src/types/server.globals.d.ts

@@ -1,38 +1,13 @@
 import "./jsx.globals.js";
 
-import { Logger, WebSocketServer, ReadBuffer, URLEncodedParser, JSONParser, TextParser, CORS, SessionHandler } from "@miqro/core/lib.js";
-import { request } from "./@miqro/request.js";
+import { Logger } from "./@miqro/core/lib.js";
+import { request } from "./@miqro/request/lib.js";
 import { RuntimeHTMLElement, Runtime, RuntimeContainer, RuntimeURL, RuntimeOptions, RuntimeShadowRootInit } from "./@miqro/jsx.js";
+import { ServerGlobal } from "./miqro.js";
 
 declare global {
   // only available server side
-  var server: {
-    /*// null values are if the feature has been disabled
-    db: {
-      get(name: string): Database | null;
-    },
-    ws: {
-      get(path: string): WebSocketServer | undefined;
-      disconnectAll(path: string): void;
-    };
-    cache: {
-      get: (key: string) => any;
-      set: (key: string, value: unknown) => void;
-      delete: (key: string) => void;
-      has: (key: string) => boolean;
-    };
-    logger: Logger;*/
-    middleware: {
-      buffer: typeof ReadBuffer;
-      url: typeof URLEncodedParser;
-      json: typeof JSONParser;
-      text: typeof TextParser;
-      cors: typeof CORS;
-      session: typeof SessionHandler;
-    }
-    encodeHTML: (str: string) => string;
-    inflateMDtoHTML: (str: string) => string;
-  }
+  var server: ServerGlobal;
 
   var test: {
     PORT: string;

package/src/types.ts

@@ -1,7 +1,7 @@
 import { Database } from "@miqro/query";
 import { WebSocketServerOptions, SessionHandlerOptions, Logger, WebSocketServer, ReadBuffer, URLEncodedParser, JSONParser, TextParser, CORS, SessionHandler, RouteOptions, Handler, Request, Response, LogLevel, LoggerTransportWriteArgs, CORSOptions, HandlerWithOptions, ErrorHandler } from "@miqro/core";
 import { request } from "@miqro/request";
-import { ParserInterface } from "@miqro/parser";
+import { Parser, ParserInterface } from "@miqro/parser";
 import { RuntimeHTMLElement, Runtime, RuntimeContainer, RuntimeURL, RuntimeOptions, RuntimeShadowRootInit } from "@miqro/jsx";
 import {
   RuntimeElementDefinitionOptions,
@@ -11,6 +11,27 @@ import {
   enableDebugLog
 } from "@miqro/jsx";
 import * as jsxLib from "@miqro/jsx";
+import { EncryptOptions, JWTDecryptOptions, JWTDecryptResult, JWTPayload, JWTVerifyOptions, JWTVerifyResult, ProtectedHeaderParameters, SignOptions } from "jose";
+import { KeyObject } from "node:crypto";
+
+export interface EncryptJWTOptions {
+  alg?: string;
+  enc?: string;
+  iat?: number | string | Date;
+  iss?: string;
+  aud?: string;
+  exp?: number | string | Date;
+  options?: EncryptOptions;
+}
+
+export interface JWTSignOptions {
+  alg?: string;
+  iat?: number | string | Date;
+  iss?: string;
+  aud?: string;
+  exp?: number | string | Date;
+  options?: SignOptions;
+}
 
 declare global {
   // jsx only for the default value of tsconfig.json
@@ -55,6 +76,61 @@ export interface ServerGlobal {
     cors: typeof CORS;
     session: typeof SessionHandler;
   };
+  newParser(): Parser;
+  newClusterCache: (name: string, logger?: Logger) => CacheInterface;
+  newLocalCache: (name: string, logger?: Logger) => CacheInterface;
+  createSecretKey: (key: string, encoding: BufferEncoding) => KeyObject;
+  getWorkerCount: () => number;
+  getWorkerNumber: () => number;
+  isPrimaryWorker: () => boolean;
+  jwt: {
+    /**
+   * creates a JWT encrypted token with jose
+   * 
+   * @param payload the payload to encrypt
+   * @param secret the secret example. const secret = createSecretKey(process.env.JWT_SECRET, 'utf-8');
+   * @param options options like expiratation date, issuer and audience
+   * @returns 
+   */
+    encrypt: (payload: JWTPayload, secret: KeyObject, options?: Partial<EncryptJWTOptions>) => Promise<string>
+    /**
+     * decrypts a JWT token with jose
+     * @param jwt the JWT token
+     * @param secret the secret example. const secret = createSecretKey(process.env.JWT_SECRET, 'utf-8');
+     * @param options options like issuer and audience
+     * @returns 
+     */
+    decrypt: <PayloadType = JWTPayload>(jwt: string, secret: KeyObject, options?: Partial<JWTDecryptOptions>) => Promise<JWTDecryptResult<PayloadType>>;
+    /**
+     * verify a JWT token with jose
+     * @param jwt the JWT token
+     * @param secret the secret example. const secret = createSecretKey(process.env.JWT_SECRET, 'utf-8');
+     * @param options options like issuer and audience
+     * @returns 
+     */
+    verify: <PayloadType = JWTPayload>(jwt: string, secret: KeyObject, options?: Partial<JWTVerifyOptions>) => Promise<JWTVerifyResult<PayloadType>>;
+    /**
+     * creates a signed JWT with jose
+     * 
+     * @param payload the payload to encrypt
+     * @param secret the secret example. const secret = createSecretKey(process.env.JWT_SECRET, 'utf-8');
+     * @param options options like expiratation date, issuer and audience
+     * @returns 
+     */
+    sign: (payload: JWTPayload, secret: KeyObject, options?: Partial<JWTSignOptions>) => Promise<string>;
+    /**
+     * decodes a protected header with jose
+     * @param token 
+     * @returns 
+     */
+    decodeProtectedHeader: (token: string | object) => ProtectedHeaderParameters;
+    /**
+     * decodes a jwt token
+     * @param jwt 
+     * @returns 
+     */
+    decode: <PayloadType = JWTPayload>(jwt: string) => PayloadType & JWTPayload;
+  }
 }
 
 export interface CacheInterface {
@@ -92,7 +168,7 @@ export interface LogConfig {
   write: (args: LoggerTransportWriteArgs) => Promise<void> | void;
 }
 
-export interface ServerInterface {
+export interface ServerInterface extends ServerGlobal {
   // null values are if the feature has been disabled
   db: {
     get(name: string): Database | null;
@@ -106,9 +182,6 @@ export interface ServerInterface {
   cache: CacheInterface;
   localCache: CacheInterface;
   logger?: Logger;
-  isPrimaryWorker: () => boolean;
-  getWorkerNumber: () => number;
-  getWorkerCount: () => number;
   openBrowser: (path: string) => void;
   getLogger: (identifier: string, options?: { level?: any; transports?: any[]; formatter?: any; }) => Logger;
 }