equipped 5.0.0-alpha.13 → 5.0.0-alpha.14

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [5.0.0-alpha.14](https://github.com/kevinand11/equipped/compare/v5.0.0-alpha.13...v5.0.0-alpha.14) (2024-07-07)
+
+
+### Features
+
+* add redocs doc ([f98347e](https://github.com/kevinand11/equipped/commit/f98347e5b815467a9c2a8bff97bdbfa166bc4c7d))
+* redirect to scalar doc ([884f271](https://github.com/kevinand11/equipped/commit/884f271910d4bc2b1f2d50a6bbcf76f6889db85e))
+
 ## [5.0.0-alpha.13](https://github.com/kevinand11/equipped/compare/v5.0.0-alpha.12...v5.0.0-alpha.13) (2024-07-04)
 
 ## [5.0.0-alpha.12](https://github.com/kevinand11/equipped/compare/v5.0.0-alpha.11...v5.0.0-alpha.12) (2024-07-04)

package/lib/db/mongoose/changes.js

@@ -52,7 +52,7 @@ class MongoDbChange extends _instance_1.DbChange {
                 } : {}),
                 'collection.include.list': dbColName
             });
-            const hexId = '5f5f65717569707065645f5f'; // __equipped__
+            const hexId = '5f5f65717569707065645f5f';
             const TestId = new mongoose_1.default.Types.ObjectId(hexId);
             const hydrate = (data) => model.hydrate({
                 ...data, _id: makeId(data._id['$oid'] ?? data._id)

package/lib/db/mongoose/index.js

@@ -71,6 +71,5 @@ class MongoDb extends _instance_1.Db {
 }
 exports.MongoDb = MongoDb;
 _MongoDb_started = new WeakMap(), _MongoDb_instances = new WeakSet(), _MongoDb_connections_get = function _MongoDb_connections_get() {
-    // @ts-ignore
     return mongoose_1.default.connection.otherDbs ?? [];
 };

package/lib/db/mongoose/query.js

@@ -4,7 +4,6 @@ exports.parseMongodbQueryParams = void 0;
 const instance_1 = require("../../instance");
 const query_1 = require("../query");
 const parseMongodbQueryParams = async (model, params) => {
-    // Handle where clauses
     const query = [];
     const whereType = Object.values(query_1.QueryKeys).indexOf(params.whereType) !== -1 ? params.whereType : query_1.QueryKeys.and;
     const authType = Object.values(query_1.QueryKeys).indexOf(params.authType) !== -1 ? params.authType : query_1.QueryKeys.and;
@@ -25,13 +24,10 @@ const parseMongodbQueryParams = async (model, params) => {
     const totalClause = {};
     if (query.length > 0)
         totalClause['$and'] = query;
-    // Handle sort clauses
     const sort = params.sort?.map((p) => [p.field, p.desc ? 'desc' : 'asc']) ?? [];
     const all = params.all ?? false;
-    // Handle limit clause
     const settings = instance_1.Instance.get().settings;
     const limit = Number(params.limit) <= settings.paginationDefaultLimit ? Number(params.limit) : settings.paginationDefaultLimit;
-    // Handle offset clause
     let page = Number.isNaN(Number(params.page)) ? 0 : Number(params.page);
     page = page < 1 ? 1 : page;
     const total = await model.countDocuments(totalClause).catch(() => {

package/lib/emails/index.js

@@ -7,7 +7,6 @@ exports.readEmailFromPug = void 0;
 const path_1 = __importDefault(require("path"));
 const pug_1 = __importDefault(require("pug"));
 const readEmailFromPug = async (filePath, data) => {
-    // filePath needs to be relative to the root of the running process
     const file = path_1.default.join('./', filePath);
     return pug_1.default.renderFile(file, data);
 };

package/lib/exit.js

@@ -7,7 +7,6 @@ const addWaitBeforeExit = (fn) => {
 };
 exports.addWaitBeforeExit = addWaitBeforeExit;
 const exit = (message) => {
-    // eslint-disable-next-line no-console
     console.error(message);
     process.exit(1);
 };
@@ -22,7 +21,6 @@ Object.entries(signals).forEach(([signal, code]) => {
         await Promise.all(listeners.map(async (l) => {
             try {
                 await typeof l === 'function' ? l() : l;
-                // eslint-disable-next-line no-empty
             }
             catch (err) {
             }

package/lib/scripts/json-schema.js

@@ -28,12 +28,31 @@ const ts_oas_1 = __importStar(require("ts-oas"));
 const instance_1 = require("../instance");
 const server_1 = require("../server");
 const statusCodes = Object.entries(server_1.StatusCodes);
+const fileSchema = { type: 'string', format: 'binary', example: 'uploaded binary file' };
+function isFile(schema) {
+    return schema.type === 'string' && schema.enum?.at(0) === 'equipped-file-schema';
+}
 function generateJSONSchema(patterns, paths, options) {
     const tsProgram = (0, ts_oas_1.createProgram)(paths, options?.tsConfig);
     const logger = instance_1.Instance.createLogger();
     const tsoas = new ts_oas_1.default(tsProgram, {
         ref: false,
         nullableKeyword: false,
+        schemaProcessor: (schema) => {
+            if (isFile(schema))
+                return fileSchema;
+            if (schema.anyOf) {
+                const index = schema.anyOf.findIndex(isFile);
+                if (index !== -1)
+                    schema.anyOf[index] = fileSchema;
+            }
+            if (schema.allOf) {
+                const index = schema.allOf.findIndex(isFile);
+                if (index !== -1)
+                    schema.allOf[index] = fileSchema;
+            }
+            return schema;
+        },
         ...(options?.options ?? {})
     });
     const jsonSchema = tsoas.getSchemas(patterns);

package/lib/server/impls/base.js

@@ -24,6 +24,7 @@ const listeners_1 = require("../../listeners");
 const middlewares_1 = require("../middlewares");
 const requests_1 = require("../requests");
 const routes_1 = require("../routes");
+const types_1 = require("../types");
 class Server {
     constructor(server) {
         _Server_instances.add(this);
@@ -87,11 +88,31 @@ class Server {
         return (0, supertest_1.default)(this.server);
     }
     async start(port) {
+        this.addRoute({
+            method: 'get',
+            path: `${this.settings.openapiDocsPath}/`,
+            handler: () => new requests_1.Response({
+                status: types_1.StatusCodes.Found,
+                headers: { 'Location': './index.html' },
+            }),
+            hideSchema: true,
+        });
         this.addRoute({
             method: 'get',
             path: `${this.settings.openapiDocsPath}/index.html`,
             handler: () => new requests_1.Response({
-                body: openapiHtml
+                body: scalarHtml
+                    .replaceAll('__API_TITLE__', this.settings.appId)
+                    .replaceAll('__OPENAPI_JSON_URL__', './openapi.json'),
+                headers: { 'Content-Type': 'text/html' },
+            }),
+            hideSchema: true,
+        });
+        this.addRoute({
+            method: 'get',
+            path: `${this.settings.openapiDocsPath}/redoc.html`,
+            handler: () => new requests_1.Response({
+                body: redocHtml
                     .replaceAll('__API_TITLE__', this.settings.appId)
                     .replaceAll('__OPENAPI_JSON_URL__', './openapi.json'),
                 headers: { 'Content-Type': 'text/html' },
@@ -163,7 +184,7 @@ _Server_routesByPath = new WeakMap(), _Server_routesByKey = new WeakMap(), _Serv
     __classPrivateFieldGet(this, _Server_routesByKey, "f").set(key, fullRoute);
     this.registerRoute(fullRoute);
 };
-const openapiHtml = `
+const scalarHtml = `
 <!doctype html>
 <html>
   <head>
@@ -182,7 +203,27 @@ const openapiHtml = `
       const configuration = { theme: 'purple' };
       document.getElementById('api-reference').dataset.configuration = JSON.stringify(configuration);
     </script>
-    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.24.30"></script>
+    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.24.36"></script>
+  </body>
+</html>
+`;
+const redocHtml = `
+<!doctype html>
+<html>
+  <head>
+    <title>__API_TITLE__</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+	<style>
+      body {
+        margin: 0;
+        padding: 0;
+      }
+    </style>
+  </head>
+  <body>
+    <redoc spec-url="__OPENAPI_JSON_URL__"></redoc>
+    <script src="https://cdn.redoc.ly/redoc/v2.1.5/bundles/redoc.standalone.js"> </script>
   </body>
 </html>
 `;

package/lib/server/impls/express.js

@@ -25,7 +25,6 @@ const express_fileupload_1 = __importDefault(require("express-fileupload"));
 const express_rate_limit_1 = __importDefault(require("express-rate-limit"));
 const helmet_1 = __importDefault(require("helmet"));
 const http_1 = __importDefault(require("http"));
-// @ts-ignore
 const json_schema_resolver_1 = __importDefault(require("json-schema-resolver"));
 const pino_http_1 = require("pino-http");
 const errors_1 = require("../../errors");
@@ -68,11 +67,6 @@ class ExpressServer extends base_1.Server {
                 limit: this.settings.rateLimit,
                 handler: (_, res) => res.status(types_1.StatusCodes.TooManyRequests).json([{ message: 'Too Many Requests' }])
             }));
-        /* if (this.settings.useSlowDown) app.use(slowDown({
-            windowMs: this.settings.slowDownPeriodInMs,
-            delayAfter: this.settings.slowDownAfter,
-            delayMs: this.settings.slowDownDelayInMs
-        })) */
     }
     registerRoute(route) {
         const openapi = (0, utils_1.prepareOpenapiMethod)(route.schema, __classPrivateFieldGet(this, _ExpressServer_ref, "f"), this.baseOpenapiDoc, route.path);
@@ -131,7 +125,6 @@ class ExpressServer extends base_1.Server {
             })));
             return [key, fileArray];
         })));
-        // @ts-ignore
         return req.savedReq || (req.savedReq = new requests_1.Request({
             ip: req.ip,
             body: req.body ?? {},

package/lib/server/impls/fastify.js

@@ -25,7 +25,6 @@ const rate_limit_1 = __importDefault(require("@fastify/rate-limit"));
 const static_1 = __importDefault(require("@fastify/static"));
 const swagger_1 = __importDefault(require("@fastify/swagger"));
 const fastify_1 = __importDefault(require("fastify"));
-// import fastifySlowDown from 'fastify-slow-down'
 const qs_1 = __importDefault(require("qs"));
 const errors_1 = require("../../errors");
 const exit_1 = require("../../exit");
@@ -75,15 +74,9 @@ class FastifyServer extends base_1.Server {
                     data: buffer,
                     duration: await (0, media_1.getMediaDuration)(buffer),
                 };
-                // @ts-ignore
                 f.value = parsed;
             }
         });
-        /* if (this.settings.useSlowDown) app.register(fastifySlowDown, {
-            timeWindow: this.settings.slowDownPeriodInMs,
-            delayAfter: this.settings.slowDownAfter,
-            delay: this.settings.slowDownDelayInMs
-        }) */
         if (this.settings.useRateLimit)
             app.register(rate_limit_1.default, {
                 max: this.settings.rateLimit,
@@ -147,9 +140,8 @@ class FastifyServer extends base_1.Server {
         const handler = async (req, reply) => {
             const rawResponse = await cb(await this.parse(req, reply));
             const response = rawResponse instanceof requests_1.Response ? rawResponse : new requests_1.Response({ body: rawResponse });
-            const type = response.shouldJSONify ? 'json' : 'send';
             if (!response.piped)
-                reply.status(response.status).headers(response.headers)[type](response.body);
+                reply.status(response.status).headers(response.headers).send(response.body);
         };
         return handler;
     }

package/lib/server/requests.d.ts

@@ -5,23 +5,26 @@ import { Defined } from '../types';
 import { AuthUser, RefreshUser } from '../utils/authUser';
 import { Api, FileSchema, SupportedStatusCodes } from './types';
 type HeaderKeys = 'AccessToken' | 'RefreshToken' | 'Referer' | 'ContentType' | 'UserAgent';
-type IsFileOrFileArray<T> = T extends FileSchema ? T : T extends FileSchema[] ? T : never;
-type ApiToFiles<Def extends Api> = {
-    [K in keyof Def['body'] as IsFileOrFileArray<Def['body'][K]> extends never ? never : K]: 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

@@ -20,8 +20,8 @@ class Request {
         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 : {})
@@ -31,7 +31,6 @@ class Request {
         if (this.query?.['authType'])
             delete this.query['authType'];
         this.headers = headers;
-        this.files = files;
     }
     pipe(cb) {
         cb(this.response);

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,7 +23,7 @@ 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, 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> {
@@ -36,11 +37,7 @@ export interface Api<Res = any, Key extends string = string, Method extends Meth
     responseHeaders?: ResponeHeaders;
     defaultStatusCode?: DefaultStatus;
 }
-/**
- * @format binary
- * @example uploaded binary file
- */
-export type FileSchema = string;
+export type FileSchema = 'equipped-file-schema';
 export interface ApiDef<T extends Api> {
     key: Defined<T['key']>;
     method: Defined<T['method']>;

package/lib/server/types.js

@@ -10,6 +10,7 @@ exports.Methods = {
 };
 exports.StatusCodes = {
     Ok: 200,
+    Found: 302,
     BadRequest: 400,
     NotAuthenticated: 401,
     NotAuthorized: 403,

package/lib/utils/auth.js

@@ -36,7 +36,6 @@ const signinWithApple = async (idToken) => {
             throw new Error('');
         if (data.exp * 1000 < Date.now())
             throw new Error('expired idToken');
-        // TODO: Find out how to get profile data from api
         return data;
     }
     catch (err) {

package/lib/utils/tokens.js

@@ -28,7 +28,6 @@ const verifyAccessToken = async (token) => {
         if (!user)
             throw new errors_1.NotAuthenticatedError();
         const cachedToken = await (0, exports.getCachedAccessToken)(user.id);
-        // Cached access token was deleted, e.g. by user roles being modified, so token needs to be treated as expired
         if (token && token !== cachedToken)
             throw new errors_1.AccessTokenExpired();
         return user;
@@ -71,19 +70,9 @@ const exchangeOldForNewTokens = async ({ accessToken, refreshToken }, makeTokens
         else
             throw err;
     });
-    // If auth token is not expired, get the user id from it
     if (authUser)
         return await makeTokens(authUser.id);
     const refreshUser = await (0, exports.verifyRefreshToken)(refreshToken);
-    // const cachedRefreshToken = await getCachedRefreshToken(refreshUser.id)
-    // If no cached value, means someone used your old token for a second time, so current one got deleted from cache
-    // if (!cachedRefreshToken) throw new NotAuthenticatedError()
-    // If cached value is not equal, means someone is trying to use an old token for a second time
-    // if (refreshToken !== cachedRefreshToken) {
-    // await deleteCachedAccessToken(refreshUser.id)
-    // await deleteCachedRefreshToken(refreshUser.id)
-    // throw new RefreshTokenMisusedError()
-    // }
     return await makeTokens(refreshUser.id);
 };
 exports.exchangeOldForNewTokens = exchangeOldForNewTokens;

package/lib/validations/index.js

@@ -48,9 +48,8 @@ const file = Validate.v.file;
 Validate.v.file = (...args) => file(...args).addRule(isNotTruncated());
 exports.Schema = Validate.v;
 exports.Validation = { ...Validate, isNotTruncated, isValidPhone };
-// eslint-disable-next-line no-redeclare
 function validate(schema, value) {
-    const validator = /* schema instanceof Validate.VCore ? schema :  */ Validate.v.object(schema);
+    const validator = Validate.v.object(schema);
     const validity = validator.parse(value);
     if (validity.valid)
         return validity.value;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "equipped",
-	"version": "5.0.0-alpha.13",
+	"version": "5.0.0-alpha.14",
 	"private": false,
 	"description": "",
 	"main": "lib/index.js",