qualityapi 1.0.0-alpha.1 → 1.0.0-alpha.2

package/dist/QualityApi.js

@@ -1,9 +1,9 @@
 import Store from "./_internal/Store";
-import { QualityApiResponse as Response } from "./QualityApiResponse";
 import { QualityApiEndpointBuilder as EndpointBuilder } from "./QualityApiEndpointBuilder";
 import {} from "./QualityApiBody";
 import {} from "./QualityApiConfig";
 import {} from "./QualityApiContentType";
+import { getBodyContentType } from "./_internal/util-functions";
 var QualityApi;
 (function (QualityApi) {
     /** Starts the building process of an endpoint. Use `QualityApiEndpointBuilder`'s built-in methods (ex. `authenticate`, `body`) to build the endpoint. */
@@ -19,58 +19,46 @@ var QualityApi;
     /** Contains the most commonly used HTTP response codes. Use `_` function to define your own. */
     let Respond;
     (function (Respond) {
-        // 2xx (Success)
-        /** 200 - OK */
-        function ok(json) {
-            return _(200, json);
+        function generate(statusCode) {
+            return (body, contentType = getBodyContentType(body)) => _(statusCode, body, contentType);
         }
-        Respond.ok = ok;
-        /** 201 - Created */
-        function created(json) {
-            return _(201, json);
+        function generateNoBody(statusCode) {
+            return () => _(statusCode);
         }
-        Respond.created = created;
-        /** 204 - No content */
-        function noContent() {
-            return _(204);
-        }
-        Respond.noContent = noContent;
-        // 4xx (Client error)
-        /** 400 - Bad request */
-        function badRequest(json) {
-            return _(400, json);
-        }
-        Respond.badRequest = badRequest;
-        /** 401 - Unauthorized */
-        function unauthorized(json) {
-            return _(401, json);
-        }
-        Respond.unauthorized = unauthorized;
-        /** 403 - Forbidden */
-        function forbidden(json) {
-            return _(403, json);
-        }
-        Respond.forbidden = forbidden;
-        /** 404 - Not found */
-        function notFound(json) {
-            return _(404, json);
-        }
-        Respond.notFound = notFound;
-        /** 409 - Conflict */
-        function conflict(json) {
-            return _(409, json);
-        }
-        Respond.conflict = conflict;
-        // 5xx (Server error)
-        /** 500 - Internal server error */
-        function internalServerError(json) {
-            return _(500, json);
-        }
-        Respond.internalServerError = internalServerError;
+        // 2xx - Success
+        /** 200 OK */
+        Respond.ok = generate(200);
+        /** 201 Created */
+        Respond.created = generate(201);
+        /** 202 Accepted */
+        Respond.accepted = generate(202);
+        /** 204 No content */
+        Respond.noContent = generateNoBody(204);
+        // 4xx - Client error
+        /** 400 Bad request */
+        Respond.badRequest = generate(400);
+        /** 401 Unauthorized */
+        Respond.unauthorized = generate(401);
+        /** 403 Forbidden */
+        Respond.forbidden = generate(403);
+        /** 409 Conflict */
+        Respond.conflict = generate(400);
+        // 5xx - Client error
+        /** 500 Internal server error */
+        Respond.internalServerError = generate(500);
         // Other
         /** Creates a response outside of the predefined HTTP codes. */
-        function _(status, json) {
-            return new Response(status, json);
+        function _(status, body, contentType = getBodyContentType(body)) {
+            const isBlob = body instanceof Blob;
+            const isString = typeof body === "string";
+            const isJson = !isBlob &&
+                !isString;
+            return new Response(isJson ? JSON.stringify(body) : body, {
+                status,
+                headers: {
+                    ...(contentType && { "Content-Type": contentType })
+                }
+            });
         }
         Respond._ = _;
     })(Respond = QualityApi.Respond || (QualityApi.Respond = {}));

package/dist/QualityApiContentType.js

@@ -1,9 +1,9 @@
-export var QualityApiContentType;
-(function (QualityApiContentType) {
-    QualityApiContentType[QualityApiContentType["JSON"] = 0] = "JSON";
-    QualityApiContentType[QualityApiContentType["Blob"] = 1] = "Blob";
-    QualityApiContentType[QualityApiContentType["Bytes"] = 2] = "Bytes";
-    QualityApiContentType[QualityApiContentType["Text"] = 3] = "Text";
-    QualityApiContentType[QualityApiContentType["ArrayBuffer"] = 4] = "ArrayBuffer";
-    QualityApiContentType[QualityApiContentType["FormData"] = 5] = "FormData";
-})(QualityApiContentType || (QualityApiContentType = {}));
+export var QualityApiRequestContentType;
+(function (QualityApiRequestContentType) {
+    QualityApiRequestContentType[QualityApiRequestContentType["JSON"] = 0] = "JSON";
+    QualityApiRequestContentType[QualityApiRequestContentType["Blob"] = 1] = "Blob";
+    QualityApiRequestContentType[QualityApiRequestContentType["Bytes"] = 2] = "Bytes";
+    QualityApiRequestContentType[QualityApiRequestContentType["Text"] = 3] = "Text";
+    QualityApiRequestContentType[QualityApiRequestContentType["ArrayBuffer"] = 4] = "ArrayBuffer";
+    QualityApiRequestContentType[QualityApiRequestContentType["FormData"] = 5] = "FormData";
+})(QualityApiRequestContentType || (QualityApiRequestContentType = {}));

package/dist/QualityApiEndpointBuilder.js

@@ -1,13 +1,12 @@
 import QualityApi from "./QualityApi";
 import Store from "./_internal/./Store";
-import { QualityApiResponse } from "./QualityApiResponse";
 import { Continue } from "./Continue";
 import {} from "./QualityApiMiddleware";
 import {} from "./QualityApiBody";
 import {} from "./QualityApiRequest";
 import {} from "next-auth";
-import { formatZodError, urlSearchParamsToObj } from "./_internal/util-functions";
-import { QualityApiContentType as ContentType } from "./QualityApiContentType";
+import { formatZodError, testContentHeader, urlSearchParamsToObj } from "./_internal/util-functions";
+import { QualityApiRequestContentType as ContentType } from "./QualityApiContentType";
 import z, { ZodObject } from "zod";
 export class QualityApiEndpointBuilder {
     constructor(contentType) {
@@ -137,18 +136,21 @@ export class QualityApiEndpointBuilder {
                     this._body = await this.parseRequestBody(nextRequest);
                 }
                 catch {
-                    return QualityApi.Respond._(415).toNextResponse();
+                    return QualityApi.Respond._(415);
                 }
             }
             this._params = await context.params;
             this._searchParams = urlSearchParamsToObj(new URL(nextRequest.url).searchParams);
             for (const mw of this.middlewares) {
                 const execution = await mw(this.getRequestData(nextRequest));
-                if (!(execution instanceof Continue))
-                    return execution.toNextResponse();
+                if (execution instanceof Continue)
+                    continue;
+                testContentHeader(execution.headers);
+                return execution;
             }
-            const execFn = await fn(this.getRequestData(nextRequest));
-            return execFn.toNextResponse();
+            const fnExec = await fn(this.getRequestData(nextRequest));
+            testContentHeader(fnExec.headers);
+            return fnExec;
         };
     }
 }

package/dist/QualityApiMiddleware.js

@@ -1,3 +1,2 @@
-import { QualityApiResponse } from "./QualityApiResponse";
 import { Continue } from "./Continue";
 import {} from "./QualityApiRequest";

package/dist/_internal/Logger.js

@@ -0,0 +1,15 @@
+export var Logger;
+(function (Logger) {
+    function success(msg) {
+        console.log(`✅ Quality API: ${msg}`);
+    }
+    Logger.success = success;
+    function error(msg) {
+        console.error(`❌ Quality API: ${msg}`);
+    }
+    Logger.error = error;
+    function warn(msg) {
+        console.warn(`⚠️ Quality API: ${msg}`);
+    }
+    Logger.warn = warn;
+})(Logger || (Logger = {}));

package/dist/_internal/Store.js

@@ -1,21 +1,21 @@
-const KEY = "__QUALITYAPI__";
+import { GLOBAL_THIS_NAMESPACE } from "./globals";
 var Store;
 (function (Store) {
     function init() {
-        if (!(KEY in globalThis))
+        if (!(GLOBAL_THIS_NAMESPACE in globalThis))
             // @ts-ignore
-            globalThis[KEY] = new Map();
+            globalThis[GLOBAL_THIS_NAMESPACE] = new Map();
     }
     function get(key) {
         init();
         // @ts-ignore
-        return globalThis[KEY].get(key);
+        return globalThis[GLOBAL_THIS_NAMESPACE].get(key);
     }
     Store.get = get;
     function set(key, value) {
         init();
         // @ts-ignore
-        return globalThis[KEY].set(key, value);
+        return globalThis[GLOBAL_THIS_NAMESPACE].set(key, value);
     }
     Store.set = set;
 })(Store || (Store = {}));

package/dist/_internal/globals.js

@@ -0,0 +1,2 @@
+export const BLOB_CONTENT_TYPE = "application/octet-stream";
+export const GLOBAL_THIS_NAMESPACE = "__QUALITYAPI__";

package/dist/_internal/util-functions.js

@@ -1,3 +1,5 @@
+import { BLOB_CONTENT_TYPE } from "./globals";
+import { Logger } from "./Logger";
 export function urlSearchParamsToObj(urlSearchParams) {
     let result = {};
     for (const key of urlSearchParams.keys()) {
@@ -26,3 +28,19 @@ export function formatZodError(step, error) {
         return error;
     }
 }
+export function getBodyContentType(body) {
+    if (body instanceof Blob)
+        return BLOB_CONTENT_TYPE;
+    else if (typeof body === "string")
+        return "text/plain";
+    else
+        return "application/json";
+}
+export function testContentHeader(headers) {
+    const header = headers.get("Content-Type");
+    if (!header)
+        return;
+    if (header?.split(";")[0] !== BLOB_CONTENT_TYPE)
+        return;
+    Logger.warn("Specify a \"Content-Type\" header for responses of type blob");
+}

package/dist/index.js

@@ -1,3 +1,3 @@
 import QualityApi from "./QualityApi";
-export { QualityApiContentType } from "./QualityApiContentType";
+export { QualityApiRequestContentType } from "./QualityApiContentType";
 export default QualityApi;

package/dist/types/QualityApi.d.ts

@@ -1,8 +1,7 @@
-import { QualityApiResponse as Response } from "./QualityApiResponse";
 import { QualityApiEndpointBuilder as EndpointBuilder } from "./QualityApiEndpointBuilder";
-import { type QualityApiBody as Body } from "./QualityApiBody";
+import { type QualityApiBody } from "./QualityApiBody";
 import { type QualityApiConfig as Config } from "./QualityApiConfig";
-import { type QualityApiContentType as ContentType } from "./QualityApiContentType";
+import { type QualityApiRequestContentType as ContentType } from "./QualityApiContentType";
 type ContentTypeMap = {
     [ContentType.JSON]: Awaited<ReturnType<Request["json"]>>;
     [ContentType.Blob]: Awaited<ReturnType<Request["blob"]>>;
@@ -18,26 +17,26 @@ declare namespace QualityApi {
     function config(options: Config): void;
     /** Contains the most commonly used HTTP response codes. Use `_` function to define your own. */
     namespace Respond {
-        /** 200 - OK */
-        function ok<Json extends Body = any>(json?: Json): Response<Json>;
-        /** 201 - Created */
-        function created<Json extends Body = any>(json?: Json): Response<Json>;
-        /** 204 - No content */
-        function noContent(): Response<Body>;
-        /** 400 - Bad request */
-        function badRequest<Json extends Body = any>(json?: Json): Response<Json>;
-        /** 401 - Unauthorized */
-        function unauthorized<Json extends Body = any>(json?: Json): Response<Json>;
-        /** 403 - Forbidden */
-        function forbidden<Json extends Body = any>(json?: Json): Response<Json>;
-        /** 404 - Not found */
-        function notFound<Json extends Body = any>(json?: Json): Response<Json>;
-        /** 409 - Conflict */
-        function conflict<Json extends Body = any>(json?: Json): Response<Json>;
-        /** 500 - Internal server error */
-        function internalServerError<Json extends Body = any>(json: Json): Response<Json>;
+        /** 200 OK */
+        const ok: <Body extends QualityApiBody>(body?: Body, contentType?: string | undefined) => Response;
+        /** 201 Created */
+        const created: <Body extends QualityApiBody>(body?: Body, contentType?: string | undefined) => Response;
+        /** 202 Accepted */
+        const accepted: <Body extends QualityApiBody>(body?: Body, contentType?: string | undefined) => Response;
+        /** 204 No content */
+        const noContent: () => Response;
+        /** 400 Bad request */
+        const badRequest: <Body extends QualityApiBody>(body?: Body, contentType?: string | undefined) => Response;
+        /** 401 Unauthorized */
+        const unauthorized: <Body extends QualityApiBody>(body?: Body, contentType?: string | undefined) => Response;
+        /** 403 Forbidden */
+        const forbidden: <Body extends QualityApiBody>(body?: Body, contentType?: string | undefined) => Response;
+        /** 409 Conflict */
+        const conflict: <Body extends QualityApiBody>(body?: Body, contentType?: string | undefined) => Response;
+        /** 500 Internal server error */
+        const internalServerError: <Body extends QualityApiBody>(body?: Body, contentType?: string | undefined) => Response;
         /** Creates a response outside of the predefined HTTP codes. */
-        function _<Json extends Body>(status: number, json?: Json): Response<Json>;
+        function _<Body extends QualityApiBody>(status: number, body?: Body, contentType?: string | undefined): Response;
     }
 }
 export default QualityApi;

package/dist/types/QualityApiBody.d.ts

@@ -1,2 +1,2 @@
 export type QualityApiBody = {} | [
-];
+] | Blob | string | number;

package/dist/types/QualityApiContentType.d.ts

@@ -1,4 +1,4 @@
-export declare enum QualityApiContentType {
+export declare enum QualityApiRequestContentType {
     JSON = 0,
     Blob = 1,
     Bytes = 2,

package/dist/types/QualityApiEndpointBuilder.d.ts

@@ -1,9 +1,8 @@
-import { QualityApiResponse } from "./QualityApiResponse";
 import { type QualityApiMiddleware as Middleware } from "./QualityApiMiddleware";
 import { type QualityApiBody } from "./QualityApiBody";
 import { type QualityApiRequest } from "./QualityApiRequest";
-import { QualityApiContentType as ContentType } from "./QualityApiContentType";
-import z, { ZodObject, type ZodRawShape } from "zod";
+import { QualityApiRequestContentType as ContentType } from "./QualityApiContentType";
+import z, { ZodObject, type ZodRawShape, type ZodType } from "zod";
 export declare class QualityApiEndpointBuilder<Authenticated extends boolean, Body, Params, SearchParams> {
     private middlewares;
     private session;
@@ -19,7 +18,7 @@ export declare class QualityApiEndpointBuilder<Authenticated extends boolean, Bo
     /** Adds internal middleware that verifies end user's authentication. */
     authenticate(): QualityApiEndpointBuilder<true, Body, Params, SearchParams>;
     /** Adds internal middleware that validates the request body. */
-    body<T extends ZodRawShape>(schema: ZodObject<T>): QualityApiEndpointBuilder<Authenticated, z.infer<ZodObject<T>>, Params, SearchParams>;
+    body<T extends ZodType>(schema: T): QualityApiEndpointBuilder<Authenticated, z.infer<T>, Params, SearchParams>;
     /**
      * Adds internal middleware that validates the request's parameters (slugs).
      *
@@ -36,7 +35,7 @@ export declare class QualityApiEndpointBuilder<Authenticated extends boolean, Bo
      * Defines the final function of the endpoint.
      * This returns a Next.js-endpoint-compatible function with all middleware compiled.
      */
-    endpoint<T extends QualityApiBody>(fn: (data: QualityApiRequest<Authenticated, Body, Params, SearchParams>) => QualityApiResponse<T> | Promise<QualityApiResponse<T>>): (nextRequest: Request, context: {
+    endpoint<T extends QualityApiBody>(fn: (data: QualityApiRequest<Authenticated, Body, Params, SearchParams>) => (Response | Promise<Response>)): (nextRequest: Request, context: {
         params: Promise<{}>;
     }) => Promise<Response>;
 }

package/dist/types/QualityApiMiddleware.d.ts

@@ -1,4 +1,3 @@
-import { QualityApiResponse } from "./QualityApiResponse";
 import { Continue } from "./Continue";
 import { type QualityApiRequest } from "./QualityApiRequest";
-export type QualityApiMiddleware<Authenticated extends boolean> = (data: QualityApiRequest<Authenticated>) => QualityApiResponse<any> | Promise<QualityApiResponse<any>> | Continue;
+export type QualityApiMiddleware<Authenticated extends boolean> = (data: QualityApiRequest<Authenticated>) => Response | Promise<Response> | Continue;

package/dist/types/QualityApiRequest.d.ts

@@ -6,11 +6,11 @@ export type QualityApiRequest<Authenticated extends boolean, Body = unknown, Par
      * This can be mutated through module augmentation. See [NextAuth module augmentation](https://next-auth.js.org/getting-started/typescript#module-augmentation).
      */
     session: Authenticated extends true ? Session : (Session | null);
-    /** The request body. */
+    /** The request body. Use the `.body` middleware to validate this through your Zod schema. */
     body: Body;
-    /** The request parameters (slugs). */
+    /** The request parameters (slugs). Use the `.params` middleware to validate this through your Zod schema. */
     params: Params;
-    /** The request search parameters (query parameters). */
+    /** The request search parameters (query parameters). Use the `.searchParams` middleware to validate this through your Zod schema. */
     searchParams: SearchParams;
     /** The raw Next.js request. */
     _request: Request;

package/dist/types/_internal/Logger.d.ts

@@ -0,0 +1,5 @@
+export declare namespace Logger {
+    function success(msg: string): void;
+    function error(msg: string): void;
+    function warn(msg: string): void;
+}

package/dist/types/_internal/globals.d.ts

@@ -0,0 +1,2 @@
+export declare const BLOB_CONTENT_TYPE = "application/octet-stream";
+export declare const GLOBAL_THIS_NAMESPACE = "__QUALITYAPI__";

package/dist/types/_internal/util-functions.d.ts

@@ -1,3 +1,4 @@
+import type { QualityApiBody } from "../QualityApiBody";
 export declare function urlSearchParamsToObj(urlSearchParams: URLSearchParams): {
     [_: string]: any;
 };
@@ -11,3 +12,5 @@ export declare function formatZodError(step: string, error: {
     step: string;
     properties: {};
 };
+export declare function getBodyContentType(body?: QualityApiBody): "application/octet-stream" | "text/plain" | "application/json";
+export declare function testContentHeader(headers: Headers): void;

package/dist/types/index.d.ts

@@ -5,6 +5,5 @@ export type { QualityApiConfig } from "./QualityApiConfig.ts";
 export type { QualityApiEndpointBuilder } from "./QualityApiEndpointBuilder.ts";
 export type { QualityApiMiddleware } from "./QualityApiMiddleware.ts";
 export type { QualityApiRequest } from "./QualityApiRequest.ts";
-export type { QualityApiResponse } from "./QualityApiResponse.ts";
-export { QualityApiContentType } from "./QualityApiContentType";
+export { QualityApiRequestContentType } from "./QualityApiContentType";
 export default QualityApi;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "qualityapi",
-    "version": "1.0.0-alpha.1",
+    "version": "1.0.0-alpha.2",
     "type": "module",
     "main": "dist/index.js",
     "types": "dist/types/index.d.ts",

package/dist/QualityApiResponse.js

@@ -1,12 +0,0 @@
-import {} from "./QualityApiBody";
-export class QualityApiResponse {
-    constructor(_status, _body) {
-        this.status = _status;
-        this.body = _body;
-    }
-    toNextResponse() {
-        return (this.status === 204
-            ? new Response(undefined, { status: this.status })
-            : Response.json(this.body ?? {}, { status: this.status }));
-    }
-}

package/dist/types/QualityApiResponse.d.ts

@@ -1,7 +0,0 @@
-import { type QualityApiBody } from "./QualityApiBody";
-export declare class QualityApiResponse<Body extends QualityApiBody> {
-    readonly status: number;
-    readonly body: Body | undefined;
-    constructor(_status: number, _body?: Body);
-    toNextResponse(): Response;
-}