@ublitzjs/core 0.1.0 → 1.0.0

package/tsconfig.types.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "declarationDir": "dist/types",
+    "lib": ["ES2022"],
+    "target": "es2022"
+  },
+  "include": ["src"]
+}

package/cjs/http-codes.cjs

@@ -1,56 +0,0 @@
-"use strict";
-var { toAB } = require("./index.cjs");
-var c411 = toAB("411");
-var c400 = toAB("400");
-var c413 = toAB("413");
-var c405 = toAB("405");
-var c404 = toAB("404");
-var c405Message = toAB("Method is not allowed");
-var allowHeader = toAB("Allow");
-function checkContentLength(res, req) {
-  var CL = Number(req.getHeader("content-length"));
-  if (!CL) {
-    res.finished = true;
-    res.cork(() => res.writeStatus(c411).endWithoutBody(0, true));
-    throw new Error("Wrong content-length", { cause: { CL } });
-  }
-  return CL;
-}
-function badRequest(res, error, causeForYou) {
-  res.finished = true;
-  if (!res.aborted) res.cork(() => res.writeStatus(c400).end(toAB(error)));
-  throw new Error("Bad request", { cause: causeForYou });
-}
-function tooLargeBody(res, limit) {
-  var message = toAB("Body is too large. Limit in bytes - " + limit);
-  if (!res.aborted) res.cork(() => res.writeStatus(c413).end(message));
-  res.finished = true;
-  throw new Error("body too large", { cause: { limit } });
-}
-function seeOtherMethods(methodsArr) {
-  var methods = toAB(
-    methodsArr
-      .map((method) => method.toUpperCase())
-      .join(", ")
-      .replace("DEL", "DELETE")
-      .replace(/ WS,*/g, "")
-  );
-  return (res) =>
-    res.writeStatus(c405).writeHeader(allowHeader, methods).end(c405Message);
-}
-function notFoundConstructor(message = "Not found") {
-  var mes = toAB(message);
-  return (res) => res.writeStatus(c404).end(mes, true);
-}
-module.exports = {
-  badRequest,
-  checkContentLength,
-  notFoundConstructor,
-  seeOtherMethods,
-  tooLargeBody,
-  c400,
-  c404,
-  c405,
-  c411,
-  c413,
-};

package/cjs/http-headers.cjs

@@ -1,64 +0,0 @@
-"use strict";
-var { toAB } = require("./index.cjs");
-var helmetHeaders = {
-  "X-Content-Type-Options": "nosniff",
-  "X-DNS-Prefetch-Control": "off",
-  "X-Frame-Options": "DENY",
-  "Referrer-Policy": "same-origin",
-  "X-Permitted-Cross-Domain-Policies": "none",
-  "X-Download-Options": "noopen",
-  "Cross-Origin-Resource-Policy": "same-origin",
-  "Cross-Origin-Opener-Policy": "same-origin",
-  "Cross-Origin-Embedder-Policy": "require-corp",
-  "Origin-Agent-Cluster": "?1",
-  //"Content-Security-Policy-Report-Only":"",
-  //"Strict-Transport-Security":`max-age=${60 * 60 * 24 * 365}; includeSubDomains`,
-};
-class HeadersMap extends Map {
-  constructor(opts) {
-    super();
-    this.currentHeaders = opts;
-  }
-  remove(keys) {
-    for (const key of arguments) delete this.currentHeaders[key];
-    return this;
-  }
-  prepare() {
-    for (const key in this.currentHeaders)
-      this.set(toAB(key), toAB(this.currentHeaders[key]));
-    return delete this.currentHeaders, (res) => this.toRes(res);
-  }
-  toRes(res) {
-    for (const pair of this) res.writeHeader(pair[0], pair[1]);
-    return res;
-  }
-  static baseObj = helmetHeaders;
-}
-function setCSP(mainCSP, ...remove) {
-  var CSPstring = "";
-  for (const dir of remove) delete mainCSP[dir];
-  for (var key in mainCSP)
-    CSPstring += key + " " + mainCSP[key].join(" ") + "; ";
-  return CSPstring;
-}
-var CSPDirs = {
-  "default-src": ["'self'"],
-  "base-uri": ["'self'"],
-  "font-src": ["'self'"],
-  "form-action": ["'self'"],
-  "frame-ancestors": ["'none'"],
-  "img-src": ["'self'"],
-  "connect-src": ["'self'"],
-  "object-src": ["'none'"],
-  "script-src": ["'self'"],
-  "script-src-attr": ["'none'"],
-  "script-src-elem": ["'self'"],
-  "style-src": ["'self'"],
-  "style-src-attr": ["'none'"],
-  "style-src-elem": ["'self'"],
-  "trusted-types": ["'none'"],
-  "upgrade-insecure-requests": [],
-  "worker-src": ["'self'"],
-  "media-src": ["'self'"],
-};
-module.exports = { CSPDirs, HeadersMap, setCSP };

package/cjs/index.cjs

@@ -1,61 +0,0 @@
-"use strict";
-var uWS = require("uWebSockets.js");
-var { Buffer } = require("node:buffer");
-
-var { EventEmitter } = require("tseep");
-function registerAbort(res) {
-  if (typeof res.aborted === "boolean")
-    throw new Error("abort already registered");
-  res.aborted = false;
-  res.emitter = new EventEmitter();
-  return res.onAborted(() => {
-    res.aborted = true;
-    res.emitter.emit("abort");
-  });
-}
-var closure = (param) => param();
-function extendApp(app, ...rest) {
-  app.register = function (plugin) {
-    return plugin(this), this;
-  };
-  app.onError = function (fn) {
-    return (this._errHandler = fn), this;
-  };
-  app._startPromises = [];
-  app.ready = function () {
-    return Promise.all(this._startPromises).then(
-      () => (this._startPromises = [])
-    );
-  };
-  app.route = function (opts, plugins) {
-    if (plugins) for (const p of plugins) p(opts, this);
-    return this[opts.method](opts.path, opts.controller);
-  };
-  for (const extension of rest) Object.assign(app, extension);
-  return app;
-}
-function toAB(data) {
-  var NodeBuf = data instanceof Buffer ? data : Buffer.from(data);
-  return NodeBuf.buffer.slice(
-    NodeBuf.byteOffset,
-    NodeBuf.byteOffset + NodeBuf.byteLength
-  );
-}
-var DeclarativeResponse = uWS.DeclarativeResponse;
-DeclarativeResponse.prototype.writeHeaders = function (headers) {
-  for (const key in headers) this.writeHeader(key, headers[key]);
-  return this;
-};
-
-module.exports = {
-  DeclarativeResponse,
-  extendApp,
-  registerAbort,
-  toAB,
-  closure,
-};
-Object.assign(
-  module.exports,
-  require("./http-headers.cjs"),
-  require("./http-codes.cjs")
-);

package/mjs/http-codes.mjs

@@ -1,52 +0,0 @@
-"use strict";
-import { toAB } from "./index.mjs";
-export var c411 = toAB("411");
-export var c400 = toAB("400");
-export var c413 = toAB("413");
-export var c405 = toAB("405");
-export var c404 = toAB("404");
-var c405Message = toAB("Method is not allowed");
-var allowHeader = toAB("Allow");
-var checkHeader = toAB("content-length");
-var checkMessage = toAB("Content-Length required to be > 0");
-function checkContentLength(res, req) {
-  var CL = Number(req.getHeader(checkHeader));
-  if (!CL) {
-    res.finished = true;
-    res.cork(() => res.writeStatus(c411).end(checkMessage));
-    throw new Error("Wrong content-length", { cause: { CL } });
-  }
-  return CL;
-}
-function badRequest(res, error, causeForYou) {
-  res.finished = true;
-  if (!res.aborted) res.cork(() => res.writeStatus(c400).end(toAB(error)));
-  throw new Error("Bad request", { cause: causeForYou });
-}
-function tooLargeBody(res, limit) {
-  var message = toAB("Body is too large. Limit in bytes - " + limit);
-  if (!res.aborted) res.cork(() => res.writeStatus(c413).end(message));
-  res.finished = true;
-}
-function seeOtherMethods(methodsArr) {
-  var methods = toAB(
-    methodsArr
-      .map((method) => method.toUpperCase())
-      .join(", ")
-      .replace("DEL", "DELETE")
-      .replace(/ WS,*/g, "")
-  );
-  return (res) =>
-    res.writeStatus(c405).writeHeader(allowHeader, methods).end(c405Message);
-}
-function notFoundConstructor(message = "Not found") {
-  var mes = toAB(message);
-  return (res) => res.writeStatus(c404).end(mes, true);
-}
-export {
-  badRequest,
-  checkContentLength,
-  notFoundConstructor,
-  seeOtherMethods,
-  tooLargeBody,
-};

package/mjs/http-headers.mjs

@@ -1,63 +0,0 @@
-"use strict";
-import { toAB } from "./index.mjs";
-var helmetHeaders = {
-  "X-Content-Type-Options": "nosniff",
-  "X-DNS-Prefetch-Control": "off",
-  "X-Frame-Options": "DENY",
-  "Referrer-Policy": "same-origin",
-  "X-Permitted-Cross-Domain-Policies": "none",
-  "X-Download-Options": "noopen",
-  "Cross-Origin-Resource-Policy": "same-origin",
-  "Cross-Origin-Opener-Policy": "same-origin",
-  "Cross-Origin-Embedder-Policy": "require-corp",
-  "Origin-Agent-Cluster": "?1",
-  //"Content-Security-Policy-Report-Only":"",
-  //"Strict-Transport-Security":`max-age=${60 * 60 * 24 * 365}; includeSubDomains`,
-};
-class HeadersMap extends Map {
-  constructor(opts) {
-    super();
-    this.currentHeaders = opts;
-  }
-  remove(keys) {
-    for (const key of arguments) delete this.currentHeaders[key];
-    return this;
-  }
-  prepare() {
-    for (const key in this.currentHeaders)
-      this.set(toAB(key), toAB(this.currentHeaders[key]));
-    return delete this.currentHeaders, (res) => this.toRes(res);
-  }
-  toRes(res) {
-    for (var pair of this) res.writeHeader(pair[0], pair[1]);
-    return res;
-  }
-  static baseObj = helmetHeaders;
-}
-function setCSP(mainCSP, ...remove) {
-  var CSPstring = "";
-  for (const dir of remove) delete mainCSP[dir];
-  for (var key in mainCSP)
-    CSPstring += key + " " + mainCSP[key].join(" ") + "; ";
-  return CSPstring;
-}
-var CSPDirs = {
-  "default-src": ["'self'"],
-  "base-uri": ["'self'"],
-  "font-src": ["'self'"],
-  "form-action": ["'self'"],
-  "frame-ancestors": ["'none'"],
-  "img-src": ["'self'"],
-  "connect-src": ["'self'"],
-  "object-src": ["'none'"],
-  "script-src": ["'self'"],
-  "script-src-attr": ["'none'"],
-  "script-src-elem": ["'self'"],
-  "style-src": ["'self'"],
-  "style-src-attr": ["'none'"],
-  "style-src-elem": ["'self'"],
-  "trusted-types": ["'none'"],
-  "worker-src": ["'self'"],
-  "media-src": ["'self'"],
-};
-export { CSPDirs, HeadersMap, setCSP };

package/mjs/index.mjs

@@ -1,51 +0,0 @@
-"use strict";
-import uWS from "uWebSockets.js";
-import { Buffer } from "node:buffer";
-export * from "./http-headers.mjs";
-export * from "./http-codes.mjs";
-import { EventEmitter } from "tseep";
-function registerAbort(res) {
-  if (typeof res.aborted === "boolean")
-    throw new Error("abort already registered");
-  res.aborted = false;
-  res.emitter = new EventEmitter();
-  return res.onAborted(() => {
-    res.aborted = true;
-    res.emitter.emit("abort");
-  });
-}
-var closure = (param) => param();
-function extendApp(app, ...rest) {
-  app.register = function (plugin) {
-    return plugin(this), this;
-  };
-  app.onError = function (fn) {
-    return (this._errHandler = fn), this;
-  };
-  app._startPromises = [];
-  app.ready = function () {
-    return Promise.all(this._startPromises).then(
-      () => (this._startPromises = [])
-    );
-  };
-  app.route = function (opts, plugins) {
-    if (plugins) for (const p of plugins) p(opts, this);
-    return this[opts.method](opts.path, opts.controller);
-  };
-  for (const extension of rest) Object.assign(app, extension);
-  return app;
-}
-function toAB(data) {
-  var NodeBuf = data instanceof Buffer ? data : Buffer.from(data);
-  return NodeBuf.buffer.slice(
-    NodeBuf.byteOffset,
-    NodeBuf.byteOffset + NodeBuf.byteLength
-  );
-}
-var DeclarativeResponse = uWS.DeclarativeResponse;
-DeclarativeResponse.prototype.writeHeaders = function (headers) {
-  for (const key in headers) this.writeHeader(key, headers[key]);
-  return this;
-};
-
-export { DeclarativeResponse, extendApp, registerAbort, toAB, closure };

package/types/http-codes.d.ts

@@ -1,54 +0,0 @@
-import type { HttpResponse as uwsHttpResponse } from "uWebSockets.js";
-import type { HttpRequest, HttpMethods } from ".";
-/**
- * If something wrong is to content-length, sends 411 code and throws error with a "cause"
- */
-export function checkContentLength(
-  res: uwsHttpResponse,
-  req: HttpRequest
-): number;
-/**
- * sends http 400 and throws an Error with "causeForYou"
- */
-export function badRequest(
-  res: uwsHttpResponse,
-  error: string,
-  causeForYou: string
-): void;
-/**
- * sends http 413 And throws, but doesn't throw an Error
- */
-export function tooLargeBody(res: uwsHttpResponse, limit: number): void;
-/**
- * Constructs function, which sends http 405 and sets http Allow header with all methods you passed
- */
-export function seeOtherMethods(
-  methodsArr: HttpMethods[]
-): (res: uwsHttpResponse, req: any) => any;
-
-/**
- * Constructs the function, which sets 404 http code and sends the message you have specified
- */
-export function notFoundConstructor(
-  message?: string
-): (res: uwsHttpResponse, req: any) => any;
-/**
- * code: required content length
- */
-export var c411: ArrayBuffer;
-/**
- * code: bad request
- */
-export var c400: ArrayBuffer;
-/**
- * code: payload too large
- */
-export var c413: ArrayBuffer;
-/**
- * code: method not allowed
- */
-export var c405: ArrayBuffer;
-/**
- * code: not found
- */
-export var c404: ArrayBuffer;

package/types/index.d.ts

@@ -1,170 +0,0 @@
-import type {
-  HttpRequest as uwsHttpRequest,
-  TemplatedApp,
-  HttpResponse as uwsHttpResponse,
-  RecognizedString,
-  us_socket_context_t,
-} from "uWebSockets.js";
-import { Buffer } from "node:buffer";
-
-import { EventEmitter } from "tseep";
-import type { DocumentedWSBehavior } from "./uws-types";
-/**
- * function to effortlessly mark response as aborted AND to attach an event emitter, so that you can easily scale the handler. If you don't need event emitter and only some res.aborted - set it by yourself (no overkill for the handler)
- * @param res
- */
-export function registerAbort(res: uwsHttpResponse): HttpResponse;
-/**
- * An extended version of uWS.App . It provides you with several features:
- * 1) plugin registration (just like in Fastify);
- * 2) "ready" function and _startPromises array (use it to make your code more asynchronous and safe)
- * 3) "route" function for more descriptive adn extensible way of registering handlers
- * 4) "onError" function (mainly used by @ublitzjs/router)
- */
-export interface Server extends TemplatedApp {
-  /**
-   * It is same as plugins in Fastify -> you register some routes in remove file
-   * @param plugin
-   * @returns itself for chaining methods
-   */
-  register(plugin: (server: this) => void): this;
-  /** set global _errHandler (in fact it is used only by @ublitzjs/router) */
-  onError(fn: (error: Error, res: HttpResponse, data: any) => any): this;
-  _errHandler?(error: Error, res: HttpResponse, data: any): any;
-  /**some undocumented property in uWS - get it here */
-  addChildAppDescriptor(...any: any[]): this;
-  /**a function, which awaits all promises inside _startPromises array and then clears it*/
-  ready: () => Promise<any[]>;
-  /**
-   * simple array of promises. You can push several inside and await all of them using server.ready() method
-   */
-  _startPromises: Promise<any>[];
-  /**
-   * this function allows you to create new handlers but more dynamically than uWS. Best use case - development. By default, the first param you pass includes a method, path, and a controller. However you can configure it for additional properties, which can be consumed on startup by second param - plugins
-   * @example
-   * server.route<onlyHttpMethods, {deprecated:boolean}>({
-   *   method:"any",
-   *   path: "/",
-   *   controller(res){ res.end("hello") },
-   *   deprecated:true
-   * },
-   * [
-   *   (opts)=>{
-   *     if(opts.deprecated) console.error("DEPRECATION FOUND", opts.path)
-   *   }
-   * ])
-   */
-  route<T extends HttpMethods, obj extends object = {}>(
-    opts: routeFNOpts<T> & obj,
-    plugins?: ((param: typeof opts, server: this) => void)[]
-  ): this;
-  get(pattern: RecognizedString, handler: HttpControllerFn): this;
-  post(pattern: RecognizedString, handler: HttpControllerFn): this;
-  options(pattern: RecognizedString, handler: HttpControllerFn): this;
-  del(pattern: RecognizedString, handler: HttpControllerFn): this;
-  patch(pattern: RecognizedString, handler: HttpControllerFn): this;
-  put(pattern: RecognizedString, handler: HttpControllerFn): this;
-  head(pattern: RecognizedString, handler: HttpControllerFn): this;
-  connect(pattern: RecognizedString, handler: HttpControllerFn): this;
-  trace(pattern: RecognizedString, handler: HttpControllerFn): this;
-  any(pattern: RecognizedString, handler: HttpControllerFn): this;
-}
-export type routeFNOpts<T extends HttpMethods> = {
-  method: T;
-  path: RecognizedString;
-  controller: T extends "ws" ? DocumentedWSBehavior<any> : HttpControllerFn;
-};
-
-/**
- * Utility for making closures. Exists for organizing code and caching values in non-global scope.
- * @param param
- * @returns what you passed
- */
-export var closure: <T>(param: () => T) => T;
-/**
- * little more typed response which has:
- * 1) "emitter", that comes from "tseep" package
- * 2) "aborted" flag
- * 3) "finished" flag
- * 4) "collect" function, which comes from original uWS (and isn't documented), but the purpose remains unknown
- */
-export interface HttpResponse<UserDataForWS extends object = {}>
-  extends uwsHttpResponse {
-  upgrade<UserData = UserDataForWS>(
-    userData: UserData,
-    secWebSocketKey: RecognizedString,
-    secWebSocketProtocol: RecognizedString,
-    secWebSocketExtensions: RecognizedString,
-    context: us_socket_context_t
-  ): void;
-  /**
-   * This method actually exists in original uWebSockets.js, but is undocumented. I'll put it here for your IDE to be happy
-   */
-  collect: (...any: any[]) => any;
-  /**
-   * An event emitter, which lets you subscribe several listeners to "abort" event OR your own events, defined with Symbol().
-   */
-  emitter: EventEmitter<{
-    abort: () => void;
-    [k: symbol]: (...any: any[]) => void;
-  }>;
-  /**
-   * changes when res.onAborted fires.
-   */
-  aborted?: boolean;
-  /**
-   * You should set it manually when ending the response. Particularly useful if some error has fired and you are doubting whether res.aborted is a sufficient flag.
-   */
-  finished: boolean;
-}
-/**This HttpRequest is same as original uWS.HttpRequest, but getHeader method is typed for additional tips
- * @example
- * import {lowHeaders} from "ublitzjs"
- * // some handler later
- * req.getHeader<lowHeaders>("content-type")
- */
-export interface HttpRequest extends uwsHttpRequest {
-  getHeader<T extends RecognizedString = RecognizedString>(a: T): string;
-}
-
-export type HttpControllerFn = (
-  res: HttpResponse,
-  req: HttpRequest
-) => any | Promise<any>;
-/**
- * only http methods without "ws"
- */
-export type onlyHttpMethods =
-  | "get"
-  | "post"
-  | "del"
-  | "patch"
-  | "put"
-  | "head"
-  | "trace"
-  | "options"
-  | "connect"
-  | "any";
-/**
- * all httpMethods with "ws" method
- */
-export type HttpMethods = onlyHttpMethods | "ws"; //NOT A HTTP METHOD, but had to put it here
-type MergeObjects<T extends any[]> = T extends [infer First, ...infer Rest]
-  ? First & MergeObjects<Rest extends any[] ? Rest : []>
-  : {};
-/**
- * extends uWS.App() or uWS.SSLApp. See interface Server
- * @param app uWS.App()
- */
-export function extendApp<T extends object[]>(
-  app: TemplatedApp,
-  ...rest: T
-): Server & MergeObjects<T>;
-/**
- * conversion to ArrayBuffer ('cause transferring strings to uWS is really slow)
- */
-export function toAB(data: Buffer | string): ArrayBuffer;
-
-export * from "./http-headers";
-export * from "./http-codes";
-export * from "./uws-types";