equipped 5.0.0-beta.9 → 5.0.0-rc.2

package/lib/server/middlewares/requireAuthUser.js

@@ -11,8 +11,8 @@ exports.requireAuthUser = (0, types_1.makeMiddleware)(async (request) => {
     if (!request.authUser)
         throw new errors_1.NotAuthenticatedError();
 }, (route) => {
-    route.security ?? (route.security = []);
+    route.security ??= [];
     route.security.push({ AccessToken: [] });
-    route.descriptions ?? (route.descriptions = []);
+    route.descriptions ??= [];
     route.descriptions.push('Requires a valid Access-Token header.');
 });

package/lib/server/middlewares/requireRefreshUser.d.ts

@@ -1,4 +1,4 @@
 export declare const requireRefreshUser: {
-    cb: import("../types").RouteMiddlewareHandler<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, import("../types").SupportedStatusCodes>>;
-    onSetup?: import("../types").HandlerSetup | undefined;
+    cb: import("../types").RouteMiddlewareHandler<import("../types").Api<any, string, import("../types").MethodTypes, any, Record<string, string>, Record<string, any>, Record<string, string | string[]>, Record<string, string | string[]>, import("../types").SupportedStatusCodes>>;
+    onSetup?: import("../types").HandlerSetup;
 };

package/lib/server/middlewares/requireRefreshUser.js

@@ -12,8 +12,8 @@ exports.requireRefreshUser = (0, types_1.makeMiddleware)(async (request) => {
     if (!request.refreshUser)
         throw new errors_1.NotAuthorizedError();
 }, (route) => {
-    route.security ?? (route.security = []);
+    route.security ??= [];
     route.security.push({ RefreshToken: [] });
-    route.descriptions ?? (route.descriptions = []);
+    route.descriptions ??= [];
     route.descriptions.push('Requires a valid Refresh-Token header.');
 });

package/lib/server/requests.d.ts

@@ -1,27 +1,30 @@
-/// <reference types="node" />
 import { Writable } from 'stream';
 import { CustomError } from '../errors';
 import { StorageFile } from '../storage';
 import { Defined } from '../types';
 import { AuthUser, RefreshUser } from '../utils/authUser';
-import { Api, SupportedStatusCodes } from './types';
+import { Api, FileSchema, SupportedStatusCodes } from './types';
 type HeaderKeys = 'AccessToken' | 'RefreshToken' | 'Referer' | 'ContentType' | 'UserAgent';
-type ApiToFiles<Def extends Api> = {
-    [K in keyof Defined<Def['files']>]: StorageFile[];
+type IsFileOrFileArray<T> = T extends FileSchema ? StorageFile[] : T extends FileSchema[] ? StorageFile[] : T;
+type ApiToBody<Def extends Api> = MappedUnion<Def['body']>;
+type UnionMapper<T> = {
+    [K in T extends infer P ? keyof P : never]: T extends infer P ? K extends keyof P ? {
+        [Q in keyof T]: IsFileOrFileArray<T[Q]>;
+    } : never : never;
 };
+type MappedUnion<T> = UnionMapper<T>[keyof UnionMapper<T>];
 export declare class Request<Def extends Api = Api> {
     #private;
     private readonly response;
     readonly ip: string | undefined;
     readonly method: Def['method'];
     readonly path: string;
-    readonly body: Def['body'];
+    readonly body: ApiToBody<Def>;
     readonly params: Defined<Def['params']>;
     readonly query: Defined<Def['query']>;
     readonly cookies: Record<string, any>;
     readonly rawBody: unknown;
     readonly headers: Record<HeaderKeys, string | null> & Record<string, string | string[] | null>;
-    readonly files: ApiToFiles<Def>;
     authUser: null | AuthUser;
     refreshUser: null | RefreshUser;
     pendingError: null | CustomError;
@@ -32,7 +35,7 @@ export declare class Request<Def extends Api = Api> {
         query: Def['query'];
         cookies: Record<string, any>;
         headers: Record<HeaderKeys, string | null> & Record<string, string | string[] | null>;
-        files: ApiToFiles<Def>;
+        files: Record<string, StorageFile[]>;
         method: Def['method'];
         path: string;
     }, response: Writable);

package/lib/server/requests.js

@@ -1,37 +1,46 @@
 "use strict";
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _Request_instances, _Request_parseQueryStrings;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Response = exports.Request = void 0;
 const json_1 = require("../utils/json");
 const types_1 = require("./types");
 class Request {
+    response;
+    ip;
+    method;
+    path;
+    body;
+    params;
+    query;
+    cookies;
+    rawBody;
+    headers;
+    authUser = null;
+    refreshUser = null;
+    pendingError = null;
     constructor({ ip, body, cookies, params, query, method, path, headers, files }, response) {
-        _Request_instances.add(this);
         this.response = response;
-        this.authUser = null;
-        this.refreshUser = null;
-        this.pendingError = null;
         this.ip = ip;
         this.method = method;
         this.path = path;
         this.rawBody = body;
-        this.body = Object.fromEntries(Object.entries(body && typeof body === 'object' ? body : { raw: body })
-            .map(([key, value]) => [key, (0, json_1.parseJSONValue)(value)]));
+        this.body = Object.assign(Object.fromEntries(Object.entries(body && typeof body === 'object' ? body : { raw: body })
+            .map(([key, value]) => [key, (0, json_1.parseJSONValue)(value)])), files);
         this.cookies = cookies;
         this.params = params;
         this.query = Object.fromEntries(Object.entries(query && typeof body === 'object' ? query : {})
-            .map(([key, val]) => [key, __classPrivateFieldGet(this, _Request_instances, "m", _Request_parseQueryStrings).call(this, val)]));
+            .map(([key, val]) => [key, this.#parseQueryStrings(val)]));
         if (this.query?.['auth'])
             delete this.query['auth'];
         if (this.query?.['authType'])
             delete this.query['authType'];
         this.headers = headers;
-        this.files = files;
+    }
+    #parseQueryStrings(value) {
+        if (Array.isArray(value))
+            return value.map(this.#parseQueryStrings);
+        if (typeof value === 'string')
+            return (0, json_1.parseJSONValue)(value);
+        return value;
     }
     pipe(cb) {
         cb(this.response);
@@ -39,14 +48,11 @@ class Request {
     }
 }
 exports.Request = Request;
-_Request_instances = new WeakSet(), _Request_parseQueryStrings = function _Request_parseQueryStrings(value) {
-    if (Array.isArray(value))
-        return value.map(__classPrivateFieldGet(this, _Request_instances, "m", _Request_parseQueryStrings));
-    if (typeof value === 'string')
-        return (0, json_1.parseJSONValue)(value);
-    return value;
-};
 class Response {
+    body;
+    status;
+    headers;
+    piped;
     constructor({ body, status = types_1.StatusCodes.Ok, headers = { 'Content-Type': 'application/json' }, piped = false }) {
         this.body = body;
         this.status = status;

package/lib/server/routes.d.ts

@@ -1,9 +1,11 @@
 import { ClassPropertiesWrapper } from 'valleyed';
 import { AddMethodImpls, GeneralConfig, Route } from './types';
+export declare const cleanPath: (path: string) => string;
 export declare const groupRoutes: (config: GeneralConfig, routes: Route[]) => Route[];
 export declare class Router extends ClassPropertiesWrapper<AddMethodImpls> {
     #private;
     constructor(config?: GeneralConfig);
-    include(router: Router): void;
-    get routes(): Route<import("./types").ApiDef<import("./types").Api<any, string, import("./types").MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, import("./types").SupportedStatusCodes>>>[];
+    add(...routes: Route[]): void;
+    nest(...routers: Router[]): void;
+    get routes(): Route<import("./types").ApiDef<import("./types").Api<any, string, import("./types").MethodTypes, any, Record<string, string>, Record<string, any>, Record<string, string | string[]>, Record<string, string | string[]>, import("./types").SupportedStatusCodes>>>[];
 }

package/lib/server/routes.js

@@ -1,59 +1,59 @@
 "use strict";
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var _Router_instances, _Router_config, _Router_routes, _Router_children, _Router_addRoute;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Router = exports.groupRoutes = void 0;
+exports.Router = exports.groupRoutes = exports.cleanPath = void 0;
 const valleyed_1 = require("valleyed");
 const types_1 = require("./types");
+const cleanPath = (path) => {
+    let cleaned = path.replace(/(\/\s*)+/g, '/');
+    if (!cleaned.startsWith('/'))
+        cleaned = `/${cleaned}`;
+    if (cleaned !== '/' && cleaned.endsWith('/'))
+        cleaned = cleaned.slice(0, -1);
+    return cleaned;
+};
+exports.cleanPath = cleanPath;
 const groupRoutes = (config, routes) => routes
     .map((route) => ({
     ...config,
     ...route,
-    path: `${config.path}/${route.path}`,
-    tags: [...(config.tags ?? []), ...(route.tags ?? [])],
+    path: (0, exports.cleanPath)(`${config.path}/${route.path}`),
+    groups: [...(config.groups ?? []), ...(route.groups ?? [])],
     middlewares: [...(config.middlewares ?? []), ...(route.middlewares ?? [])],
     security: [...(config.security ?? []), ...(route.security ?? [])],
 }));
 exports.groupRoutes = groupRoutes;
 class Router extends valleyed_1.ClassPropertiesWrapper {
+    #config = { path: '' };
+    #routes = [];
+    #children = [];
     constructor(config) {
-        const methodImpls = Object.fromEntries(Object.values(types_1.Methods).map((method) => [method, (route) => __classPrivateFieldGet(this, _Router_instances, "m", _Router_addRoute).call(this, method, route)]));
+        const methodImpls = Object.fromEntries(Object.values(types_1.Methods).map((method) => [method, (route) => this.#addRoute(method, route)]));
         super(methodImpls);
-        _Router_instances.add(this);
-        _Router_config.set(this, { path: '' });
-        _Router_routes.set(this, []);
-        _Router_children.set(this, []);
         if (config)
-            __classPrivateFieldSet(this, _Router_config, config, "f");
+            this.#config = config;
     }
-    include(router) {
-        __classPrivateFieldGet(this, _Router_children, "f").push(router);
+    #addRoute(method, routeConfig, collection = this.#routes) {
+        return (handler) => {
+            const route = (0, exports.groupRoutes)(this.#config, [{ ...routeConfig, method, handler }])[0];
+            collection.push(route);
+            return route;
+        };
+    }
+    add(...routes) {
+        const mapped = (0, exports.groupRoutes)(this.#config, routes);
+        this.#routes.push(...mapped);
+    }
+    nest(...routers) {
+        routers.forEach((router) => this.#children.push(router));
     }
     get routes() {
-        const routes = __classPrivateFieldGet(this, _Router_routes, "f");
-        __classPrivateFieldGet(this, _Router_children, "f").forEach((child) => {
+        const routes = [...this.#routes];
+        this.#children.forEach((child) => {
             child.routes.forEach((route) => {
-                __classPrivateFieldGet(this, _Router_instances, "m", _Router_addRoute).call(this, route.method, route, routes)(route.handler);
+                this.#addRoute(route.method, route, routes)(route.handler);
             });
         });
         return routes;
     }
 }
 exports.Router = Router;
-_Router_config = new WeakMap(), _Router_routes = new WeakMap(), _Router_children = new WeakMap(), _Router_instances = new WeakSet(), _Router_addRoute = function _Router_addRoute(method, routeConfig, collection = __classPrivateFieldGet(this, _Router_routes, "f")) {
-    return (handler) => {
-        const route = (0, exports.groupRoutes)(__classPrivateFieldGet(this, _Router_config, "f"), [{ ...routeConfig, method, handler }])[0];
-        collection.push(route);
-        return route;
-    };
-};

package/lib/server/types.d.ts

@@ -13,6 +13,7 @@ export declare const Methods: {
 export type MethodTypes = Enum<typeof Methods>;
 export declare const StatusCodes: {
     readonly Ok: 200;
+    readonly Found: 302;
     readonly BadRequest: 400;
     readonly NotAuthenticated: 401;
     readonly NotAuthorized: 403;
@@ -22,29 +23,33 @@ export declare const StatusCodes: {
     readonly AccessTokenExpired: 461;
 };
 export type SupportedStatusCodes = Enum<typeof StatusCodes>;
-type GoodStatusCodes = 200;
+type GoodStatusCodes = 200 | 302;
 type ApiErrors = Record<Exclude<SupportedStatusCodes, GoodStatusCodes>, JSONValue<CustomError['serializedErrors']>>;
 type ApiResponse<T, StatusCode extends SupportedStatusCodes> = Record<StatusCode, JSONValue<T>> | Omit<ApiErrors, StatusCode>;
-export interface Api<Res = any, Key extends string = string, Method extends MethodTypes = MethodTypes, Body = any, Files extends Record<string, boolean> = Record<string, boolean>, Params extends Record<string, string> = Record<string, string>, Query extends Record<string, any> = Record<string, any>, DefaultStatus extends SupportedStatusCodes = SupportedStatusCodes> {
+export interface Api<Res = any, Key extends string = string, Method extends MethodTypes = MethodTypes, Body = any, Params extends Record<string, string> = Record<string, string>, Query extends Record<string, any> = Record<string, any>, RequestHeaders extends Record<string, string | string[]> = Record<string, string | string[]>, ResponeHeaders extends Record<string, string | string[]> = Record<string, string | string[]>, DefaultStatus extends SupportedStatusCodes = SupportedStatusCodes> {
     key: Key;
     method: Method;
     response: Res;
     body?: Body;
-    files?: Files;
     params?: Params;
     query?: Query;
+    requestHeaders?: RequestHeaders;
+    responseHeaders?: ResponeHeaders;
     defaultStatusCode?: DefaultStatus;
 }
-export interface ApiDef<T extends AnyApi> {
+export type FileSchema = 'equipped-file-schema';
+export interface ApiDef<T extends Api> {
     key: Defined<T['key']>;
     method: Defined<T['method']>;
     body: Defined<T['body']>;
     params: Defined<T['params']>;
     query: Defined<T['query']>;
-    files: Defined<T['files']>;
+    requestHeaders: Defined<T['requestHeaders']>;
+    responseHeaders: Defined<T['responseHeaders']>;
     responses: ApiResponse<T['response'], GetDefaultStatusCode<T['defaultStatusCode']>>;
+    __apiDef: true;
 }
-type AnyApi<Method extends MethodTypes = MethodTypes> = Api<any, any, Method, any, any, any, any, any>;
+type AnyApi<Method extends MethodTypes = MethodTypes> = Api<any, any, Method, any, any, any, any, any, any>;
 type Awaitable<T> = Promise<T> | T;
 type Res<T, S extends SupportedStatusCodes> = Awaitable<Response<T, S> | T>;
 type InferApiFromApiDef<T> = T extends ApiDef<infer A> ? A : never;
@@ -55,6 +60,11 @@ export type RouteMiddlewareHandler<Def extends Api = Api> = (req: Request<Def>)
 export type HandlerSetup = (route: Route) => void;
 export type RouteSchema = Omit<FastifySchema, 'tags' | 'security' | 'hide' | 'description'> & {
     descriptions?: string[];
+    title?: string;
+};
+type RouteGroup = {
+    name: string;
+    description?: string;
 };
 export interface Route<Def extends ApiDef<AnyApi> = ApiDef<Api>> {
     key?: Def['key'];
@@ -65,7 +75,7 @@ export interface Route<Def extends ApiDef<AnyApi> = ApiDef<Api>> {
     middlewares?: ReturnType<typeof makeMiddleware>[];
     onError?: ReturnType<typeof makeErrorMiddleware>;
     schema?: RouteSchema;
-    tags?: string[];
+    groups?: (RouteGroup | RouteGroup['name'])[];
     descriptions?: string[];
     hideSchema?: boolean;
     security?: Record<string, string[]>[];
@@ -81,6 +91,6 @@ declare class MiddlewareHandler<Cb extends Function> {
     private constructor();
     static make<Cb extends Function>(cb: Cb, onSetup?: HandlerSetup): MiddlewareHandler<Cb>;
 }
-export declare const makeMiddleware: <Def extends AnyApi<MethodTypes> = Api<any, string, MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, SupportedStatusCodes>>(cb: RouteMiddlewareHandler<Def>, onSetup?: HandlerSetup | undefined) => MiddlewareHandler<RouteMiddlewareHandler<Def>>;
-export declare const makeErrorMiddleware: <Def extends AnyApi<MethodTypes> = Api<any, string, MethodTypes, any, Record<string, boolean>, Record<string, string>, Record<string, any>, SupportedStatusCodes>>(cb: ErrorHandler<Def>, onSetup?: HandlerSetup | undefined) => MiddlewareHandler<ErrorHandler<Def>>;
+export declare const makeMiddleware: <Def extends Api = Api<any, string, MethodTypes, any, Record<string, string>, Record<string, any>, Record<string, string | string[]>, Record<string, string | string[]>, SupportedStatusCodes>>(cb: RouteMiddlewareHandler<Def>, onSetup?: HandlerSetup | undefined) => MiddlewareHandler<RouteMiddlewareHandler<Def>>;
+export declare const makeErrorMiddleware: <Def extends Api = Api<any, string, MethodTypes, any, Record<string, string>, Record<string, any>, Record<string, string | string[]>, Record<string, string | string[]>, SupportedStatusCodes>>(cb: ErrorHandler<Def>, onSetup?: HandlerSetup | undefined) => MiddlewareHandler<ErrorHandler<Def>>;
 export {};

package/lib/server/types.js

@@ -10,6 +10,7 @@ exports.Methods = {
 };
 exports.StatusCodes = {
     Ok: 200,
+    Found: 302,
     BadRequest: 400,
     NotAuthenticated: 401,
     NotAuthorized: 403,
@@ -19,6 +20,8 @@ exports.StatusCodes = {
     AccessTokenExpired: 461,
 };
 class MiddlewareHandler {
+    cb;
+    onSetup;
     constructor(cb, onSetup) {
         this.cb = cb;
         this.onSetup = onSetup;

package/lib/storage/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export interface StorageFile {
     name: string;
     type: string;

package/lib/structure/baseEntity.js

@@ -14,22 +14,20 @@ const deleteKeyFromObject = (obj, keys) => {
     return deleteKeyFromObject(obj[keys[0]], keys.slice(1));
 };
 class BaseEntity extends valleyed_1.ClassPropertiesWrapper {
-    constructor() {
-        super(...arguments);
-        this.__hash = utils_1.Random.string();
-        this.__type = this.constructor.name;
-        this.__ignoreInJSON = [];
-    }
+    __hash = utils_1.Random.string();
+    __type = this.constructor.name;
+    __ignoreInJSON = [];
     toJSON(includeIgnored = false) {
         const json = {};
         Object.keys(this)
             .concat(Object.getOwnPropertyNames(Object.getPrototypeOf(this)))
-            .filter((k) => k !== 'constructor')
             .forEach((key) => {
             const value = this[key];
-            json[key] = value?.toJSON?.(includeIgnored) ?? structuredClone(value);
+            if (typeof value === 'function')
+                return;
+            json[key] = value?.toJSON?.(includeIgnored) ?? (0, utils_1.clone)(value);
         });
-        if (!includeIgnored)
+        if (includeIgnored !== true)
             this.__ignoreInJSON.concat('__ignoreInJSON').forEach((k) => deleteKeyFromObject(json, k.split('.')));
         return json;
     }

package/lib/types/index.d.ts

@@ -15,6 +15,6 @@ export type Paths<T, D = never> = T extends StopTypes ? '' : T extends readonly
 }[keyof T & string];
 export type JSONPrimitives = string | number | boolean | null;
 export type JSONValue<T> = T extends JSONPrimitives ? T : T extends Array<infer U> ? JSONValue<U>[] : T extends BaseEntity<infer _M, infer I> ? JSONValue<DeepOmit<T, I, '__ignoreInJSON'>> : T extends Function ? never : T extends object ? {
-    [K in keyof T & (number | string) as JSONValue<T[K]> extends never ? never : JSONValue<T[K]> extends undefined ? never : K]: JSONValue<T[K]>;
-} : T extends unknown ? unknown : undefined extends T ? JSONValue<Exclude<T, undefined>> | undefined : never;
+    [K in keyof T as JSONValue<T[K]> extends never ? never : JSONValue<T[K]> extends undefined ? never : K]: JSONValue<T[K]>;
+} : never;
 export {};

package/lib/utils/auth.d.ts

@@ -1,21 +1,21 @@
 export declare const signinWithGoogle: (idToken: string) => Promise<{
     email: string;
-    email_verified: 'true' | 'false';
+    email_verified: "true" | "false";
     first_name: string;
     last_name: string;
     picture: string;
     sub: string;
 } & Record<string, any>>;
 export declare const signinWithApple: (idToken: string) => Promise<{
-    email?: string | undefined;
+    email?: string;
     sub: string;
-    email_verified?: "false" | "true" | undefined;
-    is_private_email?: "false" | "true" | undefined;
+    email_verified?: "true" | "false";
+    is_private_email?: "true" | "false";
 } & Record<string, any>>;
 export declare const signinWithFacebook: (accessToken: string, fields?: string[]) => Promise<{
     id: string;
     email: string;
-    email_verified: 'true' | 'false';
+    email_verified: "true" | "false";
     name: string;
     picture: {
         data: {

package/lib/utils/authUser.d.ts

@@ -6,5 +6,6 @@ export interface AuthUser {
     id: string;
     roles: AuthRoles;
 }
-export interface AuthRoles extends Partial<Record<Enum<IAuthRole>, boolean>> {
-}
+export type AuthRoles = {
+    [Role in Enum<IAuthRole>]?: boolean;
+};

package/lib/utils/media.d.ts

@@ -1,2 +1 @@
-/// <reference types="node" />
 export declare const getMediaDuration: (buffer: Buffer) => Promise<number>;

package/lib/utils/utils.d.ts

@@ -2,3 +2,4 @@ export declare class Random {
     static string(length?: number): string;
     static number(min?: number, max?: number): number;
 }
+export declare function clone<T>(value: T): T;

package/lib/utils/utils.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Random = void 0;
+exports.clone = clone;
 const crypto_1 = __importDefault(require("crypto"));
 class Random {
     static string(length = 20) {
@@ -14,3 +15,11 @@ class Random {
     }
 }
 exports.Random = Random;
+function clone(value) {
+    try {
+        return structuredClone(value);
+    }
+    catch (err) {
+        return value;
+    }
+}