@orion-js/models 3.0.16 → 3.0.26

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Orionjs Team
+Copyright (c) 2021 Orionjs Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/createModel/index.js

@@ -11,6 +11,7 @@ const modelToSchema_1 = __importDefault(require("./modelToSchema"));
 const createModel = modelOptions => {
     const name = modelOptions.name;
     let resolvedSchema = null;
+    let resolvedCleanSchema = null;
     let resolvedResolvers = null;
     const getSchema = () => {
         if (!modelOptions.schema)
@@ -18,9 +19,18 @@ const createModel = modelOptions => {
         if (resolvedSchema)
             return resolvedSchema;
         const schema = (0, resolveParam_1.default)(modelOptions.schema);
-        resolvedSchema = (0, modelToSchema_1.default)(schema);
+        resolvedSchema = (0, modelToSchema_1.default)(schema, model);
         return resolvedSchema;
     };
+    const getCleanSchema = () => {
+        if (!modelOptions.schema)
+            return {};
+        if (resolvedCleanSchema)
+            return resolvedCleanSchema;
+        const schema = (0, resolveParam_1.default)(modelOptions.schema);
+        resolvedCleanSchema = (0, modelToSchema_1.default)(schema);
+        return resolvedCleanSchema;
+    };
     const getResolvers = () => {
         if (!modelOptions.resolvers)
             return {};
@@ -38,15 +48,20 @@ const createModel = modelOptions => {
         __isModel: true,
         name,
         getSchema,
+        getCleanSchema,
         getResolvers,
         initItem: modelInitItem,
         validate: async (doc) => {
-            const schema = getSchema();
+            const schema = getCleanSchema();
+            if (modelOptions.validate) {
+                await modelOptions.validate(doc);
+            }
             return await (0, schema_1.validate)(schema, doc);
         },
         clean: async (doc) => {
-            const schema = getSchema();
-            return await (0, schema_1.clean)(schema, doc);
+            const schema = getCleanSchema();
+            const cleanedDoc = modelOptions.clean ? await modelOptions.clean(doc) : doc;
+            return await (0, schema_1.clean)(schema, cleanedDoc);
         },
         clone: (cloneOptions) => {
             return (0, clone_1.default)({

package/lib/createModel/modelToSchema.d.ts

@@ -1 +1,2 @@
-export default function (schema: any): any;
+import { Model } from '..';
+export default function (schema: any, model?: Model): any;

package/lib/createModel/modelToSchema.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const isArray_1 = __importDefault(require("lodash/isArray"));
 const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
-function default_1(schema) {
+function default_1(schema, model) {
     schema = (0, cloneDeep_1.default)(schema);
     const keys = Object.keys(schema);
     for (const key of keys) {
@@ -18,6 +18,13 @@ function default_1(schema) {
             schema[key].type = schema[key].type.getSchema();
         }
     }
-    return schema;
+    if (!model)
+        return schema;
+    return {
+        ...schema,
+        __model: model,
+        __validate: model.validate,
+        __clean: model.clean
+    };
 }
 exports.default = default_1;

package/lib/createModel/modelToSchema.test.d.ts

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

package/lib/createModel/modelToSchema.test.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = __importDefault(require("."));
+it('should add the __model field when converting to schema', async () => {
+    const model = (0, _1.default)({
+        name: 'test',
+        schema: {
+            name: { type: String },
+            age: { type: Number }
+        }
+    });
+    const schema = model.getSchema();
+    expect(schema.__model.name).toEqual('test');
+});

package/lib/createModel/resolvers.test.js

@@ -29,3 +29,27 @@ it('should call the resolver', async () => {
     await (0, helpers_1.sleep)(100);
     expect(await item.res({ p: 1 })).toBe(3);
 });
+it('should call the custom clean function if present', async () => {
+    const AModel = (0, index_1.default)({
+        name: 'AModel',
+        schema: {
+            someValue: {
+                type: String
+            }
+        },
+        clean: doc => ({ someValue: 'hello world' })
+    });
+    const aResolver = (0, resolvers_1.resolver)({
+        params: {
+            model: {
+                type: AModel
+            }
+        },
+        resolve: ({ model }) => {
+            return model;
+        }
+    });
+    const doc = AModel.initItem({ someValue: 'hello' });
+    const result = await aResolver.resolve({ model: doc });
+    expect(result.someValue).toBe('hello world');
+});

package/lib/createModel/validation.test.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_1 = __importDefault(require("./index"));
+const resolvers_1 = require("@orion-js/resolvers");
 it('should validate a schema', async () => {
     const model = (0, index_1.default)({
         name: 'AModel',
@@ -44,3 +45,28 @@ it('should allow deep model validation', async () => {
         expect(error.code).toBe('validationError');
     }
 });
+it('[regression test]: should allow correct doc cleaning for resolver params', async () => {
+    const Point = (0, index_1.default)({
+        name: 'Point',
+        schema: {
+            latitude: {
+                type: Number
+            },
+            longitude: {
+                type: Number
+            }
+        }
+    });
+    const resolver1 = (0, resolvers_1.resolver)({
+        params: {
+            point: {
+                type: Point
+            }
+        },
+        async resolve({ point }) {
+            return point;
+        }
+    });
+    const doc = await resolver1.resolve({ point: { latitude: '11', longitude: '12' } });
+    expect(doc).toEqual({ latitude: 11, longitude: 12 });
+});

package/lib/types/index.d.ts

@@ -25,6 +25,17 @@ export interface CreateModelOptions {
     resolvers?: ModelResolversMap | (() => {
         default: ModelResolversMap;
     });
+    /**
+     * Optional function that will process the document before being returned.
+     * @param doc The current document
+     * @return The processed document promise
+     */
+    clean?: (doc: any) => Promise<any> | any;
+    /**
+     * Optional function that will validate the document before being returned.
+     * @param doc The current document
+     */
+    validate?: (doc: any) => Promise<void> | void;
 }
 export interface ModelResolversMap {
     [key: string]: Resolver<ModelResolverResolve, true>;
@@ -49,7 +60,13 @@ export interface Model {
     /**
      * Returns the schema of the model
      */
-    getSchema: () => Schema;
+    getSchema: () => Schema & {
+        __model: Model;
+    };
+    /**
+     * Returns the schema without adding __model to the schema
+     */
+    getCleanSchema: () => Schema;
     /**
      * Returns the model resolvers
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/models",
-  "version": "3.0.16",
+  "version": "3.0.26",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -13,18 +13,19 @@
     "prepare": "yarn run build",
     "clean": "rm -rf ./lib",
     "build": "yarn run clean && tsc",
-    "watch": "yarn run clean && tsc -w"
+    "watch": "tsc -w",
+    "upgrade-interactive": "yarn upgrade-interactive"
   },
   "dependencies": {
-    "@orion-js/helpers": "^3.0.0",
-    "@orion-js/resolvers": "^3.0.16",
-    "@orion-js/schema": "^3.0.7"
+    "@orion-js/helpers": "^3.0.17",
+    "@orion-js/resolvers": "^3.0.24",
+    "@orion-js/schema": "^3.0.17"
   },
   "peerDependencies": {
     "@orion-js/cache": "^3.0.0-alpha.10"
   },
   "devDependencies": {
-    "@orion-js/cache": "^3.0.0-alpha.23",
+    "@orion-js/cache": "^3.0.17",
     "@shelf/jest-mongodb": "^2.1.0",
     "@types/jest": "^27.0.2",
     "@types/lodash": "4.14.176",
@@ -35,5 +36,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "99af482fd83086d4588da728d7c5d4ee1688aff7"
+  "gitHead": "1a23db17e115fe86aefce8f496b063ecaa7d37e7"
 }