@orion-js/file-manager 3.7.4 → 3.7.6

package/globalConfig.json

@@ -0,0 +1 @@
+{"mongoUri":"mongodb://127.0.0.1:53531/"}

package/jest.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+  preset: '@shelf/jest-mongodb',
+  roots: ['./src'],
+  testMatch: ['**/__tests__/**/*.+(ts|tsx|js)', '**/?(*.)+(spec|test).+(ts|tsx|js)'],
+  transform: {
+    '^.+\\.(ts|tsx)$': 'ts-jest'
+  },
+  setupFilesAfterEnv: ['./src/tests/setup.ts'],
+  verbose: true
+}

package/lib/File/index.d.ts

@@ -1,2 +1,3 @@
-declare const _default: import("@orion-js/models").Model<any>;
+import { FileSchema } from './schema';
+declare const _default: import("@orion-js/models").Model<FileSchema>;
 export default _default;

package/lib/File/index.js

@@ -4,23 +4,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const models_1 = require("@orion-js/models");
-const Files_1 = __importDefault(require("../Files"));
+const Files_1 = require("../Files");
 const pick_1 = __importDefault(require("lodash/pick"));
 const omit_1 = __importDefault(require("lodash/omit"));
-const schema_1 = __importDefault(require("./schema"));
+const schema_1 = require("./schema");
+const typed_model_1 = require("@orion-js/typed-model");
+const schema = (0, typed_model_1.getModelForClass)(schema_1.FileSchema).getSchema();
 exports.default = (0, models_1.createModel)({
     name: 'File',
-    schema: schema_1.default,
+    schema: schema,
     resolvers: () => require('./resolvers'),
     // this is only called when its child
     async clean(value) {
         if (!value)
             return null;
         const fileId = value._id;
-        const file = await Files_1.default.findOne(fileId);
+        const file = await Files_1.Files.findOne({ _id: fileId });
         if (!file)
             return null;
-        const keys = Object.keys((0, omit_1.default)(schema_1.default, 'createdBy', 'createdAt', 'status'));
+        const keys = Object.keys((0, omit_1.default)(schema, 'createdBy', 'createdAt', 'status'));
         const data = (0, pick_1.default)(file, keys);
         return data;
     }

package/lib/File/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/File/index.test.js

@@ -0,0 +1,109 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = __importDefault(require("."));
+const Files_1 = require("../Files");
+const models_1 = require("@orion-js/models");
+const typed_model_1 = require("@orion-js/typed-model");
+const schema_1 = require("./schema");
+describe('File model', () => {
+    it('should correctly clean on a simple file input', async () => {
+        await Files_1.Files.insertOne({
+            _id: '1',
+            externalUrl: 'https://example.com/file.jpg'
+        });
+        const input = {
+            name: 'test',
+            image: {
+                _id: '1'
+            }
+        };
+        const model = (0, models_1.createModel)({
+            name: 'Test',
+            schema: {
+                name: {
+                    type: String
+                },
+                image: {
+                    type: _1.default
+                }
+            }
+        });
+        const cleaned = await model.clean(input);
+        expect(cleaned).toEqual({
+            name: 'test',
+            image: {
+                _id: '1',
+                externalUrl: 'https://example.com/file.jpg'
+            }
+        });
+    });
+    it('should correctly clean the file input on a complex schema', async () => {
+        await Files_1.Files.insertOne({
+            _id: '2',
+            externalUrl: 'https://example.com/file.jpg'
+        });
+        let Banner = class Banner {
+        };
+        __decorate([
+            (0, typed_model_1.Prop)({
+                type: _1.default
+            }),
+            __metadata("design:type", schema_1.FileSchema)
+        ], Banner.prototype, "image", void 0);
+        __decorate([
+            (0, typed_model_1.Prop)(),
+            __metadata("design:type", String)
+        ], Banner.prototype, "name", void 0);
+        Banner = __decorate([
+            (0, typed_model_1.TypedSchema)()
+        ], Banner);
+        const cleanedBanner = await (0, typed_model_1.getModelForClass)(Banner).clean({
+            name: 'test',
+            image: {
+                _id: '2'
+            }
+        });
+        expect(cleanedBanner).toEqual({
+            name: 'test',
+            image: {
+                _id: '2',
+                externalUrl: 'https://example.com/file.jpg'
+            }
+        });
+        let Config = class Config {
+        };
+        __decorate([
+            (0, typed_model_1.Prop)({ type: [(0, typed_model_1.getModelForClass)(Banner)] }),
+            __metadata("design:type", Array)
+        ], Config.prototype, "banners", void 0);
+        Config = __decorate([
+            (0, typed_model_1.TypedSchema)()
+        ], Config);
+        const cleaned = await (0, typed_model_1.getModelForClass)(Config).cleanAndValidate({
+            banners: [cleanedBanner]
+        });
+        expect(cleaned).toEqual({
+            banners: [
+                {
+                    name: 'test',
+                    image: {
+                        _id: '2',
+                        externalUrl: 'https://example.com/file.jpg'
+                    }
+                }
+            ]
+        });
+    });
+});

package/lib/File/resolvers/index.d.ts

@@ -1,5 +1,5 @@
 declare const _default: {
-    url: import("@orion-js/resolvers").ModelResolver<(file: any, viewer: any) => Promise<any>>;
+    url: import("@orion-js/resolvers").ModelResolver<(file: any) => Promise<string>>;
     genericType: import("@orion-js/resolvers").ModelResolver<(file: any, viewer: any) => Promise<"unknown" | "image" | "pdf">>;
 };
 export default _default;

package/lib/File/resolvers/url.d.ts

@@ -1,2 +1,4 @@
-declare const _default: import("@orion-js/resolvers").ModelResolver<(file: any, viewer: any) => Promise<any>>;
+import { FileSchema } from '../schema';
+export declare function getFileURL(file: FileSchema): string;
+declare const _default: import("@orion-js/resolvers").ModelResolver<(file: any) => Promise<string>>;
 export default _default;

package/lib/File/resolvers/url.js

@@ -1,15 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFileURL = void 0;
 const resolvers_1 = require("@orion-js/resolvers");
 const credentials_1 = require("../../credentials");
+function getFileURL(file) {
+    if (file.externalUrl)
+        return file.externalUrl;
+    const options = (0, credentials_1.getAWSCredentials)();
+    if (options.getFileURL)
+        return options.getFileURL(file);
+    return `https://s3.amazonaws.com/${file.bucket}/${encodeURIComponent(file.key)}`;
+}
+exports.getFileURL = getFileURL;
 exports.default = (0, resolvers_1.modelResolver)({
     returns: String,
-    async resolve(file, viewer) {
-        if (file.externalUrl)
-            return file.externalUrl;
-        const options = (0, credentials_1.getAWSCredentials)();
-        if (options.getFileURL)
-            return options.getFileURL(file);
-        return `https://s3.amazonaws.com/${file.bucket}/${encodeURIComponent(file.key)}`;
+    async resolve(file) {
+        return getFileURL(file);
     }
 });

package/lib/File/schema.d.ts

@@ -1,3 +1,13 @@
-import { ModelSchema } from '@orion-js/models';
-declare const schema: ModelSchema;
-export default schema;
+export declare class FileSchema {
+    _id: string;
+    hash?: string;
+    externalUrl?: string;
+    key?: string;
+    bucket?: string;
+    name?: string;
+    type?: string;
+    size?: number;
+    status?: string;
+    createdBy?: string;
+    createdAt?: Date;
+}

package/lib/File/schema.js

@@ -1,49 +1,68 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const schema = {
-    _id: {
-        type: 'ID'
-    },
-    hash: {
-        type: String,
+exports.FileSchema = void 0;
+const typed_model_1 = require("@orion-js/typed-model");
+let FileSchema = class FileSchema {
+};
+__decorate([
+    (0, typed_model_1.Prop)({ type: 'ID' }),
+    __metadata("design:type", String)
+], FileSchema.prototype, "_id", void 0);
+__decorate([
+    (0, typed_model_1.Prop)({
         optional: true
-    },
-    externalUrl: {
-        type: String,
+    }),
+    __metadata("design:type", String)
+], FileSchema.prototype, "hash", void 0);
+__decorate([
+    (0, typed_model_1.Prop)({
         optional: true,
         private: true
-    },
-    key: {
-        type: String,
-        optional: true
-    },
-    bucket: {
-        type: String,
-        optional: true
-    },
-    name: {
-        type: String,
-        optional: true
-    },
-    type: {
-        type: String,
-        optional: true
-    },
-    size: {
-        type: Number,
-        optional: true
-    },
-    status: {
-        type: String,
-        optional: true
-    },
-    createdBy: {
-        type: String,
-        optional: true
-    },
-    createdAt: {
-        type: Date,
-        optional: true
-    }
-};
-exports.default = schema;
+    }),
+    __metadata("design:type", String)
+], FileSchema.prototype, "externalUrl", void 0);
+__decorate([
+    (0, typed_model_1.Prop)({ optional: true }),
+    __metadata("design:type", String)
+], FileSchema.prototype, "key", void 0);
+__decorate([
+    (0, typed_model_1.Prop)({ optional: true }),
+    __metadata("design:type", String)
+], FileSchema.prototype, "bucket", void 0);
+__decorate([
+    (0, typed_model_1.Prop)({ optional: true }),
+    __metadata("design:type", String)
+], FileSchema.prototype, "name", void 0);
+__decorate([
+    (0, typed_model_1.Prop)({ optional: true }),
+    __metadata("design:type", String)
+], FileSchema.prototype, "type", void 0);
+__decorate([
+    (0, typed_model_1.Prop)({ optional: true }),
+    __metadata("design:type", Number)
+], FileSchema.prototype, "size", void 0);
+__decorate([
+    (0, typed_model_1.Prop)({ optional: true }),
+    __metadata("design:type", String)
+], FileSchema.prototype, "status", void 0);
+__decorate([
+    (0, typed_model_1.Prop)({ optional: true }),
+    __metadata("design:type", String)
+], FileSchema.prototype, "createdBy", void 0);
+__decorate([
+    (0, typed_model_1.Prop)({ optional: true }),
+    __metadata("design:type", Date)
+], FileSchema.prototype, "createdAt", void 0);
+FileSchema = __decorate([
+    (0, typed_model_1.TypedSchema)()
+], FileSchema);
+exports.FileSchema = FileSchema;

package/lib/Files/index.d.ts

@@ -1,2 +1,3 @@
-declare const _default: import("@orion-js/mongodb").Collection<any>;
-export default _default;
+import { Collection } from '@orion-js/mongodb';
+import { FileSchema } from '../File/schema';
+export declare const Files: Collection<FileSchema>;

package/lib/Files/index.js

@@ -3,11 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Files = void 0;
 const mongodb_1 = require("@orion-js/mongodb");
 const File_1 = __importDefault(require("../File"));
-exports.default = (0, mongodb_1.createCollection)({
+const schema_1 = require("../File/schema");
+exports.Files = (0, mongodb_1.createCollection)({
     name: 'filemanager_files',
     model: File_1.default,
+    schema: schema_1.FileSchema,
     indexes: [
         {
             keys: {

package/lib/credentials.d.ts

@@ -1,4 +1,4 @@
-export interface Credentials {
+export interface FileManagerOptions {
     accessKeyId: string;
     secretAccessKey: string;
     region: string;
@@ -9,5 +9,5 @@ export interface Credentials {
     endpoint?: string;
     s3ForcePathStyle?: boolean;
 }
-export declare const setupFileManager: (options: any) => any;
-export declare const getAWSCredentials: () => Partial<Credentials>;
+export declare const setupFileManager: (options: FileManagerOptions) => void;
+export declare const getAWSCredentials: () => Partial<FileManagerOptions>;

package/lib/credentials.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAWSCredentials = exports.setupFileManager = void 0;
-let credentials = {};
-const setupFileManager = options => (credentials = options);
+let savedOptions = {};
+const setupFileManager = (options) => {
+    savedOptions = options;
+};
 exports.setupFileManager = setupFileManager;
-const getAWSCredentials = () => credentials;
+const getAWSCredentials = () => savedOptions;
 exports.getAWSCredentials = getAWSCredentials;

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 import resolvers from './resolvers';
 import { setupFileManager, getAWSCredentials } from './credentials';
 import File from './File';
-import Files from './Files';
-export { resolvers, setupFileManager, getAWSCredentials, File, Files };
+import { Files } from './Files';
+import { getFileURL } from './File/resolvers/url';
+export { resolvers, setupFileManager, getAWSCredentials, File, Files, getFileURL };

package/lib/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Files = exports.File = exports.getAWSCredentials = exports.setupFileManager = exports.resolvers = void 0;
+exports.getFileURL = exports.Files = exports.File = exports.getAWSCredentials = exports.setupFileManager = exports.resolvers = void 0;
 const resolvers_1 = __importDefault(require("./resolvers"));
 exports.resolvers = resolvers_1.default;
 const credentials_1 = require("./credentials");
@@ -11,5 +11,7 @@ Object.defineProperty(exports, "setupFileManager", { enumerable: true, get: func
 Object.defineProperty(exports, "getAWSCredentials", { enumerable: true, get: function () { return credentials_1.getAWSCredentials; } });
 const File_1 = __importDefault(require("./File"));
 exports.File = File_1.default;
-const Files_1 = __importDefault(require("./Files"));
-exports.Files = Files_1.default;
+const Files_1 = require("./Files");
+Object.defineProperty(exports, "Files", { enumerable: true, get: function () { return Files_1.Files; } });
+const url_1 = require("./File/resolvers/url");
+Object.defineProperty(exports, "getFileURL", { enumerable: true, get: function () { return url_1.getFileURL; } });

package/lib/resolvers/completeUpload.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("@orion-js/resolvers").Resolver<({ fileId }: any, viewer: any) => Promise<any>, undefined>;
+declare const _default: import("@orion-js/resolvers").Resolver<({ fileId }: any, viewer: any) => Promise<import("../File/schema").FileSchema>, undefined>;
 export default _default;

package/lib/resolvers/completeUpload.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const resolvers_1 = require("@orion-js/resolvers");
 const File_1 = __importDefault(require("../File"));
-const Files_1 = __importDefault(require("../Files"));
+const Files_1 = require("../Files");
 exports.default = (0, resolvers_1.resolver)({
     params: {
         fileId: {
@@ -15,8 +15,8 @@ exports.default = (0, resolvers_1.resolver)({
     returns: File_1.default,
     mutation: true,
     async resolve({ fileId }, viewer) {
-        const file = await Files_1.default.findOne({ createdBy: viewer.userId, _id: fileId });
-        await Files_1.default.updateOne(file, { $set: { status: 'uploaded' } });
+        const file = await Files_1.Files.findOne({ createdBy: viewer.userId, _id: fileId });
+        await Files_1.Files.updateOne(file, { $set: { status: 'uploaded' } });
         return file;
     }
 });

package/lib/resolvers/fileManagerFile.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("@orion-js/resolvers").Resolver<({ fileId }: any) => Promise<any>, undefined>;
+declare const _default: import("@orion-js/resolvers").Resolver<({ fileId }: any) => Promise<import("../File/schema").FileSchema>, undefined>;
 export default _default;

package/lib/resolvers/fileManagerFile.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const resolvers_1 = require("@orion-js/resolvers");
 const File_1 = __importDefault(require("../File"));
-const Files_1 = __importDefault(require("../Files"));
+const Files_1 = require("../Files");
 exports.default = (0, resolvers_1.resolver)({
     params: {
         fileId: {
@@ -14,6 +14,6 @@ exports.default = (0, resolvers_1.resolver)({
     },
     returns: File_1.default,
     async resolve({ fileId }) {
-        return await Files_1.default.findOne(fileId);
+        return await Files_1.Files.findOne(fileId);
     }
 });

package/lib/resolvers/fileManagerFiles.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const paginated_mongodb_1 = require("@orion-js/paginated-mongodb");
 const escape_string_regexp_1 = __importDefault(require("escape-string-regexp"));
 const File_1 = __importDefault(require("../File"));
-const Files_1 = __importDefault(require("../Files"));
+const Files_1 = require("../Files");
 const fileManagerFiles = (0, paginated_mongodb_1.paginatedResolver)({
     params: {
         filter: {
@@ -21,7 +21,7 @@ const fileManagerFiles = (0, paginated_mongodb_1.paginatedResolver)({
         if (filter) {
             query.name = { $regex: new RegExp(`^${(0, escape_string_regexp_1.default)(filter)}`) };
         }
-        return Files_1.default.find(query);
+        return Files_1.Files.find(query);
     }
 });
 exports.default = fileManagerFiles;

package/lib/resolvers/generateUploadCredentials.d.ts

@@ -1,5 +1,5 @@
 declare const _default: import("@orion-js/resolvers").Resolver<(params: any, viewer: any) => Promise<{
     key: string;
-    fileId: any;
+    fileId: string;
 }>, undefined>;
 export default _default;

package/lib/resolvers/generateUploadCredentials.js

@@ -8,7 +8,7 @@ const helpers_1 = require("@orion-js/helpers");
 const models_1 = require("@orion-js/models");
 const aws_sdk_1 = __importDefault(require("aws-sdk"));
 const credentials_1 = require("../credentials");
-const Files_1 = __importDefault(require("../Files"));
+const Files_1 = require("../Files");
 exports.default = (0, resolvers_1.resolver)({
     params: {
         name: {
@@ -53,7 +53,7 @@ exports.default = (0, resolvers_1.resolver)({
                 return null;
         }
         const key = `${basePath}/${(0, helpers_1.generateId)()}-${params.name}`;
-        const fileId = await Files_1.default.insertOne({
+        const fileId = await Files_1.Files.insertOne({
             key,
             bucket,
             name: params.name,

package/lib/resolvers/index.d.ts

@@ -1,10 +1,10 @@
 declare const _default: {
-    fileManagerFile: import("@orion-js/resolvers").Resolver<({ fileId }: any) => Promise<any>, undefined>;
+    fileManagerFile: import("@orion-js/resolvers").Resolver<({ fileId }: any) => Promise<import("../File/schema").FileSchema>, undefined>;
     fileManagerFiles: import("@orion-js/resolvers").Resolver<Function, undefined>;
-    completeUpload: import("@orion-js/resolvers").Resolver<({ fileId }: any, viewer: any) => Promise<any>, undefined>;
+    completeUpload: import("@orion-js/resolvers").Resolver<({ fileId }: any, viewer: any) => Promise<import("../File/schema").FileSchema>, undefined>;
     generateUploadCredentials: import("@orion-js/resolvers").Resolver<(params: any, viewer: any) => Promise<{
         key: string;
-        fileId: any;
+        fileId: string;
     }>, undefined>;
 };
 export default _default;

package/lib/tests/setup.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/tests/setup.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mongodb_1 = require("@orion-js/mongodb");
+const url = `${global.__MONGO_URI__}jest`;
+process.env.MONGO_URL = url;
+beforeAll(async () => {
+    const connection = (0, mongodb_1.getMongoConnection)({ name: 'main' });
+    await connection.connectionPromise;
+});
+afterAll(async () => {
+    /**
+     * We need to wait on indexes promises to be resolved to close all the handlers
+     */
+    await Promise.all(mongodb_1.createIndexesPromises);
+    for (const connectionName in mongodb_1.connections) {
+        const connection = mongodb_1.connections[connectionName];
+        await connection.client.close();
+    }
+});

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@orion-js/file-manager",
-  "version": "3.7.4",
+  "version": "3.7.6",
   "main": "lib/index.js",
   "author": "nicolaslopezj",
   "license": "MIT",
   "scripts": {
-    "test": "exit 0",
+    "test": "jest",
     "prepare": "yarn run build",
     "clean": "rm -rf ./lib",
     "build": "yarn run clean && tsc",
@@ -13,9 +13,9 @@
   },
   "dependencies": {
     "@orion-js/helpers": "^3.7.4",
-    "@orion-js/models": "^3.7.4",
-    "@orion-js/mongodb": "^3.7.4",
-    "@orion-js/paginated-mongodb": "^3.7.4",
+    "@orion-js/models": "^3.7.6",
+    "@orion-js/mongodb": "^3.7.6",
+    "@orion-js/paginated-mongodb": "^3.7.6",
     "@orion-js/resolvers": "^3.7.4",
     "@orion-js/schema": "^3.7.4",
     "aws-sdk": "^2.1367.0",
@@ -38,5 +38,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c77b95ffc592ddce0ba6b95ae5e34f3e273c4cd5"
+  "gitHead": "c1bb048206f0309f38d32796b0ca5729a2052ec6"
 }