@warlock.js/core 1.0.11 → 1.0.13

package/esm/modules/uploads/utils/get-uploads-directory.js

@@ -0,0 +1,13 @@
+import config from'@mongez/config';import dayjs from'dayjs';async function getUploadsDirectory(directoryInput) {
+    if (directoryInput)
+        return directoryInput;
+    const configDirectory = config.get("uploads.saveTo");
+    const path = dayjs().format("DD-MM-YYYY");
+    if (configDirectory) {
+        if (typeof configDirectory === "function") {
+            return await configDirectory(path);
+        }
+        return configDirectory;
+    }
+    return path;
+}export{getUploadsDirectory};//# sourceMappingURL=get-uploads-directory.js.map

package/esm/modules/uploads/utils/get-uploads-directory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-uploads-directory.js","sources":["../../../../src/modules/uploads/utils/get-uploads-directory.ts"],"sourcesContent":[null],"names":[],"mappings":"4DAGO,eAAe,mBAAmB,CAAC,cAAuB,EAAA;AAC/D,IAAA,IAAI,cAAc;AAAE,QAAA,OAAO,cAAc,CAAC;IAE1C,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAErD,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;AAE1C,IAAA,IAAI,eAAe,EAAE;AACnB,QAAA,IAAI,OAAO,eAAe,KAAK,UAAU,EAAE;AACzC,YAAA,OAAO,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC;AACpC,SAAA;AAED,QAAA,OAAO,eAAe,CAAC;AACxB,KAAA;AAED,IAAA,OAAO,IAAI,CAAC;AACd"}

package/esm/modules/uploads/utils/get-uploads-size.d.ts

@@ -0,0 +1,2 @@
+export declare function getUploadsSize(filter: any): Promise<any>;
+//# sourceMappingURL=get-uploads-size.d.ts.map

package/esm/modules/uploads/utils/get-uploads-size.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-uploads-size.d.ts","sourceRoot":"","sources":["../../../../src/modules/uploads/utils/get-uploads-size.ts"],"names":[],"mappings":"AAEA,wBAAsB,cAAc,CAAC,MAAM,EAAE,GAAG,gBAE/C"}

package/esm/modules/uploads/utils/get-uploads-size.js

@@ -0,0 +1,3 @@
+import {Upload}from'../models/upload.js';async function getUploadsSize(filter) {
+    return Upload.aggregate().where(filter).sum("size");
+}export{getUploadsSize};//# sourceMappingURL=get-uploads-size.js.map

package/esm/modules/uploads/utils/get-uploads-size.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-uploads-size.js","sources":["../../../../src/modules/uploads/utils/get-uploads-size.ts"],"sourcesContent":[null],"names":[],"mappings":"yCAEO,eAAe,cAAc,CAAC,MAAW,EAAA;AAC9C,IAAA,OAAO,MAAM,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AACtD"}

package/esm/modules/uploads/utils/get-watermark-options.d.ts

@@ -0,0 +1,3 @@
+import type { WatermarkOptions } from "./types";
+export declare function getWatermarkOptions(): Promise<WatermarkOptions>;
+//# sourceMappingURL=get-watermark-options.d.ts.map

package/esm/modules/uploads/utils/get-watermark-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-watermark-options.d.ts","sourceRoot":"","sources":["../../../../src/modules/uploads/utils/get-watermark-options.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,wBAAsB,mBAAmB,8BAQxC"}

package/esm/modules/uploads/utils/get-watermark-options.js

@@ -0,0 +1,7 @@
+import config from'@mongez/config';import'@mongez/fs';import'@mongez/reinforcements';import'crypto';import'fs';import'path';import'@mongez/http';import'sharp';import'@warlock.js/logger';import'../../../router/router.js';import'@fastify/multipart';import'@warlock.js/cascade';import'../../../utils/date-output.js';import {useRequestStore}from'../../../http/middleware/inject-request-context.js';import'@mongez/slug';import'@mongez/supportive-is';import'fastify';import'@warlock.js/cache';import'@mongez/copper';import'@mongez/events';import'@mongez/localization';import'../../../validator/locales.js';import'../models/upload.js';import'send';import'stream';async function getWatermarkOptions() {
+    const watermark = config.get("uploads.watermark");
+    if (!watermark)
+        return;
+    const request = useRequestStore().request;
+    return (await watermark(request));
+}export{getWatermarkOptions};//# sourceMappingURL=get-watermark-options.js.map

package/esm/modules/uploads/utils/get-watermark-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-watermark-options.js","sources":["../../../../src/modules/uploads/utils/get-watermark-options.ts"],"sourcesContent":[null],"names":[],"mappings":"gpBAIO,eAAe,mBAAmB,GAAA;IACvC,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;AAElD,IAAA,IAAI,CAAC,SAAS;QAAE,OAAO;AAEvB,IAAA,MAAM,OAAO,GAAG,eAAe,EAAE,CAAC,OAAO,CAAC;AAE1C,IAAA,QAAQ,MAAM,SAAS,CAAC,OAAO,CAAC,EAAsB;AACxD"}

package/esm/modules/uploads/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./file";
+export * from "./get-uploads-size";
+export * from "./types";
+export * from "./uploadable";
+//# sourceMappingURL=index.d.ts.map

package/esm/modules/uploads/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/modules/uploads/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC"}

package/esm/modules/uploads/utils/types.d.ts

@@ -0,0 +1,47 @@
+import type { AWSConfigurations } from "../../../aws";
+import type { Request } from "../../../http";
+import type { UploadOutput } from "../output/upload-output";
+export type WatermarkOptions = {
+    hash: string;
+    ratio?: number;
+    position?: "center" | "center-center" | "center-right" | "center-left" | "top-left" | "top-right" | "top-center" | "bottom-left" | "bottom-right" | "bottom-center";
+    opacity?: number;
+};
+export type UploadsConfigurations = {
+    /**
+     * Set the uploads path that is related to the uploads directory
+     * The path is RELATIVE to the uploads directory, do not include the uploads directory in the path
+     *
+     * @default date/hash
+     */
+    saveTo?: string | ((defaultPath: string) => string);
+    /**
+     * Uploads directory
+     */
+    root?: string | ((relativePath: string) => string);
+    /**
+     * Modify upload output before sending it to response
+     */
+    extend?: (upload: UploadOutput) => any;
+    /**
+     * Cache files in seconds
+     *
+     * @default 31536000 (1 year)
+     */
+    cacheTime?: number;
+    /**
+     * Aws Configurations
+     */
+    aws?: AWSConfigurations;
+    /**
+     * Compress images
+     *
+     * @default true
+     */
+    compress?: boolean;
+    /**
+     * Add watermark to images
+     */
+    watermark?: (request: Request) => Promise<WatermarkOptions>;
+};
+//# sourceMappingURL=types.d.ts.map

package/esm/modules/uploads/utils/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/modules/uploads/utils/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAE5D,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EACL,QAAQ,GACR,eAAe,GACf,cAAc,GACd,aAAa,GACb,UAAU,GACV,WAAW,GACX,YAAY,GACZ,aAAa,GACb,cAAc,GACd,eAAe,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,WAAW,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;IACpD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,YAAY,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;IACnD;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,GAAG,CAAC;IACvC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,GAAG,CAAC,EAAE,iBAAiB,CAAC;IACxB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC7D,CAAC"}

package/esm/modules/uploads/utils/uploadable.d.ts

@@ -0,0 +1,15 @@
+import type { GenericObject } from "@mongez/reinforcements";
+import type { Model } from "@warlock.js/cascade";
+import { File } from "./file";
+export declare function uploadFromFile(file: File): Promise<any>;
+export declare function uploadFromUrl(url: string): Promise<any>;
+/**
+ * Create an uploadable files but with additional data
+ */
+export declare function uploadableExtended(options?: GenericObject | ((model: Model) => GenericObject)): (hash: any, column: string, model: Model, sync?: boolean) => Promise<any>;
+/**
+ * Casts a value to an uploadable object.
+ * If the value is an array, it will return an array of uploadable objects.
+ */
+export declare function uploadable(hash: any, column: string, model: Model, sync?: boolean): Promise<any>;
+//# sourceMappingURL=uploadable.d.ts.map

package/esm/modules/uploads/utils/uploadable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploadable.d.ts","sourceRoot":"","sources":["../../../../src/modules/uploads/utils/uploadable.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAG5D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAQjD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,wBAAsB,cAAc,CAAC,IAAI,EAAE,IAAI,gBAqC9C;AAmCD,wBAAsB,aAAa,CAAC,GAAG,EAAE,MAAM,gBA8D9C;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,GAAE,aAAa,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,aAAa,CAAM,UAGvD,GAAG,UACD,MAAM,mCAGb,QAAQ,GAAG,CAAC,CAwChB;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAC9B,IAAI,EAAE,GAAG,EACT,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,EACZ,IAAI,UAAO,GACV,OAAO,CAAC,GAAG,CAAC,CAoCd"}

package/esm/modules/uploads/utils/uploadable.js

@@ -0,0 +1,157 @@
+import config from'@mongez/config';import {ensureDirectory,copyFile}from'@mongez/fs';import Endpoint from'@mongez/http';import {Random,trim,ltrim}from'@mongez/reinforcements';import {isUrl}from'@mongez/supportive-is';import dayjs from'dayjs';import {writeFileSync}from'fs';import path from'path';import {Upload}from'../models/upload.js';import {Image}from'../../../image/image.js';import {uploadsPath,sanitizePath}from'../../../utils/paths.js';import {File}from'./file.js';async function uploadFromFile(file) {
+    const date = dayjs().format("DD-MM-YYYY");
+    const hash = Random.string(32);
+    const filePath = file.name;
+    const uploadPath = uploadsPath(date + "/" + hash);
+    ensureDirectory(uploadPath);
+    copyFile(file.path, path.resolve(uploadPath + "/" + filePath));
+    const fileData = {
+        name: file.name,
+        fileHash: file.hash,
+        hash: hash,
+        path: date + "/" + hash + "/" + filePath,
+        size: file.size,
+        mimeType: file.mimeType,
+        extension: file.extension,
+    };
+    // check if file is image
+    const isImage = String(file.mimeType).startsWith("image");
+    if (isImage) {
+        // get image dimensions
+        const image = new Image(file.path);
+        const { width, height } = await image.dimensions();
+        fileData["width"] = width;
+        fileData["height"] = height;
+    }
+    return Upload.create(fileData);
+}
+async function getUpload(hash) {
+    if (!hash)
+        return null;
+    if (hash instanceof Upload)
+        return hash;
+    if (isUrl(hash)) {
+        return await uploadFromUrl(hash);
+    }
+    if (hash instanceof File) {
+        return await uploadFromFile(hash);
+    }
+    return await Upload.findBy("hash", hash);
+}
+async function getDirectory() {
+    const configDirectory = config.get("uploads.saveTo");
+    const hash = Random.string(32);
+    const path = dayjs().format("DD-MM-YYYY") + "/" + hash;
+    if (configDirectory) {
+        if (typeof configDirectory === "function") {
+            return await configDirectory(path);
+        }
+        return configDirectory;
+    }
+    return path;
+}
+async function uploadFromUrl(url) {
+    const urlHandler = new URL(url);
+    // get file name from url
+    const fileName = sanitizePath(trim(String(urlHandler?.pathname?.split("/")?.pop()), "/")) ||
+        Random.string(32);
+    const fileExtension = fileName.split(".").pop();
+    const hash = Random.string(32);
+    // file path should be date/hash/file.extension
+    // const filePath = fileName + "." + fileExtension;
+    const filePath = fileName;
+    const directoryPath = await getDirectory();
+    const uploadPath = uploadsPath(directoryPath);
+    ensureDirectory(uploadPath);
+    const request = new Endpoint({ baseURL: "" });
+    const response = await request.get(url, {
+        responseType: "arraybuffer",
+    });
+    const fileContent = response.data;
+    // get file size in bytes
+    const fileSize = Buffer.byteLength(fileContent);
+    // get file mime type
+    const fileMimeType = response.headers["content-type"];
+    const fullPath = uploadPath + "/" + filePath;
+    writeFileSync(fullPath, fileContent);
+    const fileData = {
+        name: fileName,
+        hash: hash,
+        path: ltrim(directoryPath + "/" + filePath, "/"),
+        size: fileSize,
+        mimeType: fileMimeType,
+        extension: fileExtension,
+    };
+    // check if file is image
+    const isImage = String(fileData.mimeType).startsWith("image");
+    if (isImage) {
+        // get image dimensions
+        const image = new Image(fullPath);
+        const { width, height } = await image.dimensions();
+        fileData["width"] = width;
+        fileData["height"] = height;
+    }
+    return Upload.create(fileData);
+}
+/**
+ * Create an uploadable files but with additional data
+ */
+function uploadableExtended(options = {}) {
+    return async function uploadable(hash, column, model, sync = true) {
+        if (Array.isArray(hash)) {
+            const value = await Promise.all(hash.map(async (item) => await uploadable(item, column, model, false)));
+            if (sync) {
+                // link the model to the upload
+                syncModelWithUpload(model, column, value);
+            }
+        }
+        if (hash?.value) {
+            hash.value = (await getUpload(hash.value))?.embeddedData;
+            return hash;
+        }
+        const upload = await getUpload(hash);
+        if (!upload)
+            return null;
+        if (typeof options === "function") {
+            options = options(model);
+        }
+        upload.merge(options).silentSaving();
+        if (sync) {
+            // link the model to the upload
+            syncModelWithUpload(model, column, upload.hash);
+        }
+        return {
+            ...upload.embeddedData,
+            ...options,
+        };
+    };
+}
+/**
+ * Casts a value to an uploadable object.
+ * If the value is an array, it will return an array of uploadable objects.
+ */
+async function uploadable(hash, column, model, sync = true) {
+    if (Array.isArray(hash)) {
+        const value = await Promise.all(hash.map(async (item) => await uploadable(item, column, model, false)));
+        if (sync) {
+            // link the model to the upload
+            syncModelWithUpload(model, column, value.map(value => value.hash));
+        }
+        return value;
+    }
+    if (hash?.value) {
+        hash.value = (await getUpload(hash.value))?.embeddedData;
+        return hash;
+    }
+    const upload = await getUpload(hash);
+    if (!upload)
+        return null;
+    if (sync) {
+        // link the model to the upload
+        syncModelWithUpload(model, column, upload.hash);
+    }
+    return upload.embeddedData;
+}
+async function syncModelWithUpload(model, column, hash) {
+    model.set("_uploads." + column, hash);
+}export{uploadFromFile,uploadFromUrl,uploadable,uploadableExtended};//# sourceMappingURL=uploadable.js.map

package/esm/modules/uploads/utils/uploadable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploadable.js","sources":["../../../../src/modules/uploads/utils/uploadable.ts"],"sourcesContent":[null],"names":[],"mappings":"ydAgBO,eAAe,cAAc,CAAC,IAAU,EAAA;IAC7C,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAE1C,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAE/B,IAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;IAE3B,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC;IAElD,eAAe,CAAC,UAAU,CAAC,CAAC;AAE5B,IAAA,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC;AAE/D,IAAA,MAAM,QAAQ,GAAG;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,QAAQ,EAAE,IAAI,CAAC,IAAI;AACnB,QAAA,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,QAAQ;QACxC,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,SAAS,EAAE,IAAI,CAAC,SAAS;KAC1B,CAAC;;AAGF,IAAA,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AAE1D,IAAA,IAAI,OAAO,EAAE;;QAEX,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEnC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;AAElD,QAAA,QAAgB,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;AAClC,QAAA,QAAgB,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;AACtC,KAAA;AAED,IAAA,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AACjC,CAAC;AAED,eAAe,SAAS,CAAC,IAAS,EAAA;AAChC,IAAA,IAAI,CAAC,IAAI;AAAE,QAAA,OAAO,IAAI,CAAC;IAEvB,IAAI,IAAI,YAAY,MAAM;AAAE,QAAA,OAAO,IAAI,CAAC;AAExC,IAAA,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE;AACf,QAAA,OAAO,MAAM,aAAa,CAAC,IAAI,CAAC,CAAC;AAClC,KAAA;IAED,IAAI,IAAI,YAAY,IAAI,EAAE;AACxB,QAAA,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,CAAC;AACnC,KAAA;IAED,OAAO,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAC3C,CAAC;AAED,eAAe,YAAY,GAAA;IACzB,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAErD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAE/B,IAAA,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC;AAEvD,IAAA,IAAI,eAAe,EAAE;AACnB,QAAA,IAAI,OAAO,eAAe,KAAK,UAAU,EAAE;AACzC,YAAA,OAAO,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC;AACpC,SAAA;AAED,QAAA,OAAO,eAAe,CAAC;AACxB,KAAA;AAED,IAAA,OAAO,IAAI,CAAC;AACd,CAAC;AACM,eAAe,aAAa,CAAC,GAAW,EAAA;AAC7C,IAAA,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;;IAEhC,MAAM,QAAQ,GACZ,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;AACxE,QAAA,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAEpB,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;IAEhD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;;;IAI/B,MAAM,QAAQ,GAAG,QAAQ,CAAC;AAE1B,IAAA,MAAM,aAAa,GAAG,MAAM,YAAY,EAAE,CAAC;AAE3C,IAAA,MAAM,UAAU,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAE9C,eAAe,CAAC,UAAU,CAAC,CAAC;IAE5B,MAAM,OAAO,GAAG,IAAI,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAE9C,MAAM,QAAQ,GAAkB,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE;AACrD,QAAA,YAAY,EAAE,aAAa;AAC5B,KAAA,CAAC,CAAC;AAEH,IAAA,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC;;IAGlC,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;;IAGhD,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;AAEtD,IAAA,MAAM,QAAQ,GAAG,UAAU,GAAG,GAAG,GAAG,QAAQ,CAAC;AAE7C,IAAA,aAAa,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AAErC,IAAA,MAAM,QAAQ,GAAG;AACf,QAAA,IAAI,EAAE,QAAQ;AACd,QAAA,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,KAAK,CAAC,aAAa,GAAG,GAAG,GAAG,QAAQ,EAAE,GAAG,CAAC;AAChD,QAAA,IAAI,EAAE,QAAQ;AACd,QAAA,QAAQ,EAAE,YAAY;AACtB,QAAA,SAAS,EAAE,aAAa;KACzB,CAAC;;AAGF,IAAA,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AAE9D,IAAA,IAAI,OAAO,EAAE;;AAEX,QAAA,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;QAElC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;AAElD,QAAA,QAAgB,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;AAClC,QAAA,QAAgB,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;AACtC,KAAA;AAED,IAAA,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AACjC,CAAC;AAED;;AAEG;AACa,SAAA,kBAAkB,CAChC,OAAA,GAA6D,EAAE,EAAA;AAE/D,IAAA,OAAO,eAAe,UAAU,CAC9B,IAAS,EACT,MAAc,EACd,KAAY,EACZ,IAAI,GAAG,IAAI,EAAA;AAEX,QAAA,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;AACvB,YAAA,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAC7B,IAAI,CAAC,GAAG,CACN,OAAO,IAAS,KAAK,MAAM,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAClE,CACF,CAAC;AAEF,YAAA,IAAI,IAAI,EAAE;;AAER,gBAAA,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAC3C,aAAA;AACF,SAAA;QAED,IAAI,IAAI,EAAE,KAAK,EAAE;AACf,YAAA,IAAI,CAAC,KAAK,GAAG,CAAC,MAAM,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,YAAY,CAAC;AAEzD,YAAA,OAAO,IAAI,CAAC;AACb,SAAA;AAED,QAAA,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC;AAErC,QAAA,IAAI,CAAC,MAAM;AAAE,YAAA,OAAO,IAAI,CAAC;AAEzB,QAAA,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;AACjC,YAAA,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;AAC1B,SAAA;QAED,MAAM,CAAC,KAAK,CAAC,OAAwB,CAAC,CAAC,YAAY,EAAE,CAAC;AAEtD,QAAA,IAAI,IAAI,EAAE;;YAER,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;AACjD,SAAA;QAED,OAAO;YACL,GAAG,MAAM,CAAC,YAAY;AACtB,YAAA,GAAG,OAAO;SACX,CAAC;AACJ,KAAC,CAAC;AACJ,CAAC;AAED;;;AAGG;AACI,eAAe,UAAU,CAC9B,IAAS,EACT,MAAc,EACd,KAAY,EACZ,IAAI,GAAG,IAAI,EAAA;AAEX,IAAA,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;AACvB,QAAA,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAC7B,IAAI,CAAC,GAAG,CACN,OAAO,IAAS,KAAK,MAAM,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAClE,CACF,CAAC;AAEF,QAAA,IAAI,IAAI,EAAE;;AAER,YAAA,mBAAmB,CACjB,KAAK,EACL,MAAM,EACN,KAAK,CAAC,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,CAC/B,CAAC;AACH,SAAA;AAED,QAAA,OAAO,KAAK,CAAC;AACd,KAAA;IAED,IAAI,IAAI,EAAE,KAAK,EAAE;AACf,QAAA,IAAI,CAAC,KAAK,GAAG,CAAC,MAAM,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,YAAY,CAAC;AAEzD,QAAA,OAAO,IAAI,CAAC;AACb,KAAA;AAED,IAAA,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC;AAErC,IAAA,IAAI,CAAC,MAAM;AAAE,QAAA,OAAO,IAAI,CAAC;AAEzB,IAAA,IAAI,IAAI,EAAE;;QAER,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;AACjD,KAAA;IAED,OAAO,MAAM,CAAC,YAAY,CAAC;AAC7B,CAAC;AAED,eAAe,mBAAmB,CAChC,KAAY,EACZ,MAAc,EACd,IAAuB,EAAA;IAEvB,KAAK,CAAC,GAAG,CAAC,WAAW,GAAG,MAAM,EAAE,IAAI,CAAC,CAAC;AACxC"}

package/esm/output/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./output";
+export * from "./types";
+//# sourceMappingURL=index.d.ts.map

package/esm/output/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/output/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC"}

package/esm/output/output.d.ts

@@ -0,0 +1,160 @@
+import { type GenericObject } from "@mongez/reinforcements";
+import { type Request } from "../http";
+import type { FinalOutput, OutputResource, OutputTransformer, OutputValue } from "./types";
+export declare class Output {
+    resource: OutputResource;
+    /**
+     * Final data output
+     */
+    protected data: GenericObject;
+    /**
+     * Disabled keys from being returned in the final output
+     */
+    protected static disabledKeys: string[];
+    /**
+     * The only allowed keys
+     */
+    protected static allowedKeys: string[];
+    /**
+     * Output shape
+     */
+    protected output: FinalOutput;
+    /**
+     * Defaults when key is missing from the given data
+     */
+    protected defaults: {};
+    /**
+     * Default date format
+     */
+    protected dateFormat: string;
+    /**
+     * Original resource data
+     */
+    originalResource: OutputResource;
+    /**
+     * Request object
+     * Injected when output is sent to response
+     * If you're going to use toJSON before sending it to response
+     * Make sure to attach the request object to the output
+     */
+    request: Request;
+    /**
+     * Constructor
+     */
+    constructor(resource?: OutputResource);
+    /**
+     * return list of resources for the given array ouf data
+     */
+    static collect(data: OutputResource[]): Output[];
+    /**
+     * Set value to the final output
+     */
+    set(key: string, value: any): this;
+    /**
+     * Get value from output resource
+     */
+    get(key: string, defaultValue?: any): any;
+    /**
+     * Update value in output resource
+     */
+    update(key: string, value: any): this;
+    /**
+     * Remove a key from the final output
+     */
+    remove(...keys: string[]): void;
+    /**
+     * Disable the given keys
+     */
+    static disable(...keys: string[]): typeof Output;
+    /**
+     * Remove the given keys from the disabled keys
+     */
+    static enable(...keys: string[]): typeof Output;
+    /**
+     * Allow only the given keys
+     */
+    static allow(...keys: string[]): typeof Output;
+    /**
+     * Reset allowed and disabled keys
+     */
+    static resetKeys(): typeof Output;
+    /**
+     * Remove the given keys from the allowed keys
+     */
+    static disallow(...keys: string[]): typeof Output;
+    /**
+     * Get final output data
+     */
+    response(): Promise<GenericObject>;
+    /**
+     * Boot method
+     * Called before transforming the resource
+     */
+    protected boot(): Promise<void>;
+    /**
+     * Extend the resource output
+     * Called after transforming the resource
+     */
+    protected extend(): Promise<void>;
+    /**
+     * Manage the output as localized value and parse the value by using the given output
+     */
+    protected localized(output: typeof Output): OutputTransformer;
+    /**
+     * Transform resource to object, that's going to be used as the final output
+     */
+    toJSON(): Promise<GenericObject>;
+    /**
+     * Transform final output
+     */
+    protected transformOutput(): Promise<void>;
+    /**
+     * Check if the given value is valid resource value
+     */
+    protected isValidResourceValue(value: any): boolean;
+    /**
+     * Check if the given key is disabled
+     */
+    protected isDisabledKey(key: string): boolean;
+    /**
+     * Check if the given key is allowed
+     */
+    protected isAllowedKey(key: string): boolean;
+    /**
+     * Transform value
+     */
+    protected transformValue(value: any, valueType: OutputValue | [string, OutputValue]): Promise<any>;
+    /**
+     * Transform the value of the given key
+     */
+    transform(key: string, type: OutputValue): Promise<any>;
+    /**
+     * Transform and store the transformed value in the final output of the given key
+     */
+    opt(key: string, type: OutputValue, setAs?: string): Promise<this>;
+    /**
+     * Get resource id
+     */
+    get id(): any;
+    /**
+     * Builtin casts
+     */
+    protected cast(value: any, type: OutputValue): any;
+    /**
+     * Parse the given value
+     */
+    protected parseDate(value: any, format?: string): import("../utils/date-output").DateOutputReturn;
+    /**
+     * Return an array of the given object for response output
+     */
+    arrayOf(options: FinalOutput): typeof Output;
+    /**
+     * Return only the values of the given keys
+     */
+    outputOnly(...keys: string[]): OutputTransformer;
+    /**
+     * Return output that contains only an id if exists
+     */
+    onlyId(): OutputTransformer;
+}
+//# sourceMappingURL=output.d.ts.map

package/esm/output/output.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.d.ts","sourceRoot":"","sources":["../../src/output/output.ts"],"names":[],"mappings":"AACA,OAAO,EAKL,KAAK,aAAa,EACnB,MAAM,wBAAwB,CAAC;AAIhC,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,SAAS,CAAC;AAIvC,OAAO,KAAK,EACV,WAAW,EAEX,cAAc,EACd,iBAAiB,EACjB,WAAW,EACZ,MAAM,SAAS,CAAC;AAEjB,qBAAa,MAAM;IAiDS,QAAQ,EAAE,cAAc;IAhDlD;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,aAAa,CAAM;IAEnC;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,CAAM;IAE7C;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,CAAM;IAE5C;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,WAAW,CAAM;IAEnC;;OAEG;IACH,SAAS,CAAC,QAAQ,KAAM;IAExB;;OAEG;IACH,SAAS,CAAC,UAAU,SAA2B;IAE/C;;OAEG;IACI,gBAAgB,EAAG,cAAc,CAAC;IAEzC;;;;;OAKG;IACI,OAAO,EAAG,OAAO,CAAC;IAIzB;;OAEG;gBACuB,QAAQ,GAAE,cAAmB;IAYvD;;OAEG;WACW,OAAO,CAAC,IAAI,EAAE,cAAc,EAAE;IAM5C;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAMlC;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG;IAI1C;;OAEG;IACI,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAMrC;;OAEG;IACI,MAAM,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE;IAI/B;;OAEG;WACW,OAAO,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE;IAcvC;;OAEG;WACW,MAAM,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE;IAYtC;;OAEG;WACW,KAAK,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE;IAerC;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,QAAQ,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE;IAYxC;;OAEG;IACI,QAAQ;IAIf;;;OAGG;cACa,IAAI;IAIpB;;;OAGG;cACa,MAAM;IAItB;;OAEG;IACH,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,MAAM;IAoCzC;;OAEG;IACU,MAAM;IAUnB;;OAEG;cACa,eAAe;IAiE/B;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,GAAG;IAQzC;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM;IAInC;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM;IAKlC;;OAEG;cACa,cAAc,CAC5B,KAAK,EAAE,GAAG,EACV,SAAS,EAAE,WAAW,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC;IAiBhD;;OAEG;IACI,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW;IAQ/C;;OAEG;IACU,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,SAAM;IAqB5D;;OAEG;IACH,IAAW,EAAE,QAEZ;IAED;;OAEG;IACH,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW;IA8D5C;;OAEG;IACH,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,SAAkB;IAOxD;;OAEG;IACI,OAAO,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,MAAM;IAMnD;;OAEG;IACI,UAAU,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE;IASnC;;OAEG;IACI,MAAM;CAWd"}