@aeriajs/builtins 0.0.0

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright 2023 João Santos (joaosan177@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,6 @@
+# `@aeriajs/builtins`
+
+## Introduction
+
+This package implements built-in collections and functions that provide basic functionalities like authentication, logging, rate limiting, and file storage.
+

package/dist/collections/file/description.d.ts

@@ -0,0 +1,50 @@
+export declare const description: {
+    readonly $id: "file";
+    readonly owned: "always";
+    readonly presets: readonly ["owned"];
+    readonly indexes: readonly ["filename", "link", "mime"];
+    readonly properties: {
+        readonly mime: {
+            readonly type: "string";
+        };
+        readonly size: {
+            readonly type: "number";
+        };
+        readonly last_modified: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+        readonly filename: {
+            readonly type: "string";
+        };
+        readonly absolute_path: {
+            readonly type: "string";
+        };
+        readonly relative_path: {
+            readonly type: "string";
+        };
+        readonly immutable: {
+            readonly type: "boolean";
+        };
+        readonly link: {
+            readonly getter: (value: any) => Promise<string>;
+        };
+        readonly download_link: {
+            readonly getter: (value: any) => Promise<string>;
+        };
+    };
+    readonly actions: {
+        readonly deleteAll: {
+            readonly name: "Remover";
+            readonly ask: true;
+            readonly selection: true;
+        };
+    };
+    readonly individualActions: {
+        readonly remove: {
+            readonly name: "Remover";
+            readonly icon: "trash";
+            readonly ask: true;
+        };
+    };
+};

package/dist/collections/file/description.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.description = void 0;
+const api_1 = require("@aeriajs/api");
+const entrypoint_1 = require("@aeriajs/entrypoint");
+const link = async (_id) => {
+    const config = await (0, entrypoint_1.getConfig)();
+    return `${config.apiUrl || ''}/file/${_id}`;
+};
+const timestamp = (lastModified) => lastModified
+    ? new Date(lastModified).getTime()
+    : 'fresh';
+exports.description = (0, api_1.defineDescription)({
+    $id: 'file',
+    owned: 'always',
+    presets: ['owned'],
+    indexes: [
+        'filename',
+        'link',
+        'mime',
+    ],
+    properties: {
+        mime: {
+            type: 'string',
+        },
+        size: {
+            type: 'number',
+        },
+        last_modified: {
+            type: 'string',
+            format: 'date-time',
+        },
+        filename: {
+            type: 'string',
+        },
+        absolute_path: {
+            type: 'string',
+        },
+        relative_path: {
+            type: 'string',
+        },
+        immutable: {
+            type: 'boolean',
+        },
+        link: {
+            getter: async (value) => {
+                return `${await link(value._id)}/${timestamp(value.last_modified)}`;
+            },
+        },
+        download_link: {
+            getter: async (value) => {
+                return `${await link(value._id)}/download/${timestamp(value.last_modified)}`;
+            },
+        },
+    },
+    actions: {
+        deleteAll: {
+            name: 'Remover',
+            ask: true,
+            selection: true,
+        },
+    },
+    individualActions: {
+        remove: {
+            name: 'Remover',
+            icon: 'trash',
+            ask: true,
+        },
+    },
+});

package/dist/collections/file/description.mjs

@@ -0,0 +1,258 @@
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _async_to_generator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _ts_generator(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+}
+import { defineDescription } from "@aeriajs/api";
+import { getConfig } from "@aeriajs/entrypoint";
+var link = function() {
+    var _ref = _async_to_generator(function(_id) {
+        var config;
+        return _ts_generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    return [
+                        4,
+                        getConfig()
+                    ];
+                case 1:
+                    config = _state.sent();
+                    return [
+                        2,
+                        "".concat(config.apiUrl || "", "/file/").concat(_id)
+                    ];
+            }
+        });
+    });
+    return function link(_id) {
+        return _ref.apply(this, arguments);
+    };
+}();
+var timestamp = function(lastModified) {
+    return lastModified ? new Date(lastModified).getTime() : "fresh";
+};
+export var description = defineDescription({
+    $id: "file",
+    owned: "always",
+    presets: [
+        "owned"
+    ],
+    indexes: [
+        "filename",
+        "link",
+        "mime"
+    ],
+    properties: {
+        mime: {
+            type: "string"
+        },
+        size: {
+            type: "number"
+        },
+        last_modified: {
+            type: "string",
+            format: "date-time"
+        },
+        filename: {
+            type: "string"
+        },
+        absolute_path: {
+            type: "string"
+        },
+        relative_path: {
+            type: "string"
+        },
+        immutable: {
+            type: "boolean"
+        },
+        link: {
+            getter: function() {
+                var _ref = _async_to_generator(function(value) {
+                    var _, _1;
+                    return _ts_generator(this, function(_state) {
+                        switch(_state.label){
+                            case 0:
+                                _1 = (_ = "").concat;
+                                return [
+                                    4,
+                                    link(value._id)
+                                ];
+                            case 1:
+                                return [
+                                    2,
+                                    _1.apply(_, [
+                                        _state.sent(),
+                                        "/"
+                                    ]).concat(timestamp(value.last_modified))
+                                ];
+                        }
+                    });
+                });
+                return function(value) {
+                    return _ref.apply(this, arguments);
+                };
+            }()
+        },
+        download_link: {
+            getter: function() {
+                var _ref = _async_to_generator(function(value) {
+                    var _, _1;
+                    return _ts_generator(this, function(_state) {
+                        switch(_state.label){
+                            case 0:
+                                _1 = (_ = "").concat;
+                                return [
+                                    4,
+                                    link(value._id)
+                                ];
+                            case 1:
+                                return [
+                                    2,
+                                    _1.apply(_, [
+                                        _state.sent(),
+                                        "/download/"
+                                    ]).concat(timestamp(value.last_modified))
+                                ];
+                        }
+                    });
+                });
+                return function(value) {
+                    return _ref.apply(this, arguments);
+                };
+            }()
+        }
+    },
+    actions: {
+        deleteAll: {
+            name: "Remover",
+            ask: true,
+            selection: true
+        }
+    },
+    individualActions: {
+        remove: {
+            name: "Remover",
+            icon: "trash",
+            ask: true
+        }
+    }
+});

package/dist/collections/file/download.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+import type { Context } from '@aeriajs/types';
+import type { description } from './description.js';
+import fs from 'fs';
+export declare enum FileReadError {
+    DocumentNotFound = "DOCUMENT_NOT_FOUND",
+    FileNotFound = "FILE_NOT_FOUND"
+}
+export declare const download: (payload: {
+    fileId: string;
+    options: readonly ('picture' | 'download')[];
+    noHeaders?: boolean;
+}, context: Context<typeof description>) => Promise<import("@aeriajs/types").Left<FileReadError.DocumentNotFound> | import("@aeriajs/types").Left<FileReadError.FileNotFound> | fs.ReadStream>;

package/dist/collections/file/download.js

@@ -0,0 +1,78 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.download = exports.FileReadError = void 0;
+const mongodb_1 = require("mongodb");
+const common_1 = require("@aeriajs/common");
+const fs_1 = __importDefault(require("fs"));
+var FileReadError;
+(function (FileReadError) {
+    FileReadError["DocumentNotFound"] = "DOCUMENT_NOT_FOUND";
+    FileReadError["FileNotFound"] = "FILE_NOT_FOUND";
+})(FileReadError || (exports.FileReadError = FileReadError = {}));
+const download = async (payload, context) => {
+    const { fileId, options = [] } = payload;
+    const file = await context.collection.model.findOne({
+        _id: new mongodb_1.ObjectId(fileId),
+    }, {
+        projection: {
+            absolute_path: 1,
+            filename: 1,
+            mime: 1,
+        },
+    });
+    if (!file) {
+        if (!payload.noHeaders) {
+            context.response.writeHead(404, {
+                'content-type': 'application/json',
+            });
+        }
+        return (0, common_1.left)(FileReadError.DocumentNotFound);
+    }
+    let stat;
+    try {
+        stat = await fs_1.default.promises.stat(file.absolute_path);
+    }
+    catch (e) {
+        context.response.writeHead(404, {
+            'content-type': 'application/json',
+        });
+        return (0, common_1.left)(FileReadError.FileNotFound);
+    }
+    const range = context.request.headers.range;
+    if (range) {
+        const parts = range.replace(/bytes=/, '').split('-');
+        const start = parseInt(parts[0]);
+        const end = parts[1]
+            ? parseInt(parts[1])
+            : stat.size - 1;
+        const chunkSize = (end - start) + 1;
+        if (!payload.noHeaders) {
+            context.response.writeHead(206, {
+                'accept-ranges': 'bytes',
+                'content-range': `bytes ${start}-${end}/${stat.size}`,
+                'content-length': chunkSize,
+                'content-type': file.mime,
+                'content-disposition': `${options.includes('download')
+                    ? 'attachment; '
+                    : ''}filename=${encodeURI(file.filename)}`,
+            });
+        }
+        return fs_1.default.createReadStream(file.absolute_path, {
+            start,
+            end,
+        });
+    }
+    if (!payload.noHeaders) {
+        context.response.writeHead(200, {
+            'content-type': file.mime,
+            'content-disposition': `${options.includes('download')
+                ? 'attachment; '
+                : ''}filename=${encodeURI(file.filename)}`,
+        });
+    }
+    return fs_1.default.createReadStream(file.absolute_path);
+};
+exports.download = download;