@orion-js/models 3.0.24 → 3.0.31

package/lib/createModel/index.js

@@ -7,10 +7,11 @@ const initItem_1 = __importDefault(require("./initItem"));
 const resolveParam_1 = __importDefault(require("./resolveParam"));
 const schema_1 = require("@orion-js/schema");
 const clone_1 = __importDefault(require("./clone"));
-const modelToSchema_1 = __importDefault(require("./modelToSchema"));
+const modelToSchema_1 = require("./modelToSchema");
 const createModel = modelOptions => {
     const name = modelOptions.name;
     let resolvedSchema = null;
+    let resolvedCleanSchema = null;
     let resolvedResolvers = null;
     const getSchema = () => {
         if (!modelOptions.schema)
@@ -18,17 +19,17 @@ const createModel = modelOptions => {
         if (resolvedSchema)
             return resolvedSchema;
         const schema = (0, resolveParam_1.default)(modelOptions.schema);
-        resolvedSchema = (0, modelToSchema_1.default)(schema, model);
+        resolvedSchema = (0, modelToSchema_1.modelToSchemaWithModel)(schema, model);
         return resolvedSchema;
     };
     const getCleanSchema = () => {
         if (!modelOptions.schema)
             return {};
-        if (resolvedSchema)
-            return resolvedSchema;
+        if (resolvedCleanSchema)
+            return resolvedCleanSchema;
         const schema = (0, resolveParam_1.default)(modelOptions.schema);
-        resolvedSchema = (0, modelToSchema_1.default)(schema);
-        return resolvedSchema;
+        resolvedCleanSchema = (0, modelToSchema_1.modelToSchema)(schema);
+        return resolvedCleanSchema;
     };
     const getResolvers = () => {
         if (!modelOptions.resolvers)
@@ -51,12 +52,16 @@ const createModel = modelOptions => {
         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,2 +1,9 @@
-import { Model } from '..';
-export default function (schema: any, model?: Model): any;
+import { Model, ModelSchema } from '..';
+import { Schema } from '@orion-js/schema';
+export declare function modelToSchema(modelSchema: ModelSchema, { cleanSchema }?: {
+    cleanSchema?: boolean;
+}): Schema;
+export declare function modelToSchemaWithModel(modelSchema: ModelSchema, model?: Model): Schema | {
+    __model: Model;
+    __clean: (item: any) => Promise<any>;
+};

package/lib/createModel/modelToSchema.js

@@ -3,26 +3,49 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.modelToSchemaWithModel = exports.modelToSchema = void 0;
 const isArray_1 = __importDefault(require("lodash/isArray"));
-const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
-function default_1(schema, model) {
-    schema = (0, cloneDeep_1.default)(schema);
-    const keys = Object.keys(schema);
-    for (const key of keys) {
-        if ((0, isArray_1.default)(schema[key].type)) {
-            if (schema[key].type[0].__isModel) {
-                schema[key].type[0] = schema[key].type[0].getSchema();
-            }
+function isModelSchema(type) {
+    return type && typeof type === 'object' && '__isModel' in type;
+}
+function isModelArraySchema(type) {
+    return type && (0, isArray_1.default)(type) && typeof type[0] === 'object' && '__isModel' in type[0];
+}
+function modelToSchema(modelSchema, { cleanSchema = true } = {}) {
+    const compiledSchema = {};
+    for (const key in modelSchema) {
+        const fieldSchema = modelSchema[key];
+        let currNode;
+        if (isModelSchema(fieldSchema.type)) {
+            currNode = {
+                ...fieldSchema,
+                type: cleanSchema ? fieldSchema.type.getCleanSchema() : fieldSchema.type.getSchema()
+            };
         }
-        if (schema[key].type && schema[key].type.__isModel) {
-            schema[key].type = schema[key].type.getSchema();
+        else if (isModelArraySchema(fieldSchema.type)) {
+            currNode = {
+                ...fieldSchema,
+                type: cleanSchema
+                    ? [fieldSchema.type[0].getCleanSchema()]
+                    : [fieldSchema.type[0].getSchema()]
+            };
         }
+        else {
+            currNode = { ...fieldSchema, type: fieldSchema.type };
+        }
+        compiledSchema[key] = currNode;
     }
+    return compiledSchema;
+}
+exports.modelToSchema = modelToSchema;
+function modelToSchemaWithModel(modelSchema, model) {
+    const schema = modelToSchema(modelSchema, { cleanSchema: !model });
     if (!model)
         return schema;
     return {
         ...schema,
-        __model: model
+        __model: model,
+        __clean: model.clean
     };
 }
-exports.default = default_1;
+exports.modelToSchemaWithModel = modelToSchemaWithModel;

package/lib/createModel/modelToSchema.test.js

@@ -3,7 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("..");
 const _1 = __importDefault(require("."));
+const schema_1 = require("@orion-js/schema");
 it('should add the __model field when converting to schema', async () => {
     const model = (0, _1.default)({
         name: 'test',
@@ -15,3 +17,33 @@ it('should add the __model field when converting to schema', async () => {
     const schema = model.getSchema();
     expect(schema.__model.name).toEqual('test');
 });
+it('can clean a schema with nested models', async () => {
+    const modelSchema = {
+        name: {
+            type: String,
+            clean: () => 'Model Schema'
+        }
+    };
+    const model = (0, _1.default)({
+        name: 'AModel',
+        schema: modelSchema
+    });
+    const schema = {
+        subModel: {
+            type: model
+        },
+        subModelArray: {
+            type: [model]
+        },
+        primitive: {
+            type: String,
+            clean: () => 'Primitive'
+        }
+    };
+    const doc = { subModel: { name: 'Joaquin' }, subModelArray: [{ name: 'Roberto' }], primitive: 'hello' };
+    expect(await (0, schema_1.clean)((0, __1.modelToSchema)(schema), doc)).toEqual({
+        subModel: { name: 'Model Schema' },
+        subModelArray: [{ name: 'Model Schema' }],
+        primitive: 'Primitive'
+    });
+});

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/index.d.ts

@@ -1,4 +1,4 @@
 import createModel from './createModel';
-import modelToSchema from './createModel/modelToSchema';
-export { createModel, modelToSchema };
+import { modelToSchema, modelToSchemaWithModel } from './createModel/modelToSchema';
+export { createModel, modelToSchema, modelToSchemaWithModel };
 export * from './types';

package/lib/index.js

@@ -13,9 +13,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.modelToSchema = exports.createModel = void 0;
+exports.modelToSchemaWithModel = exports.modelToSchema = exports.createModel = void 0;
 const createModel_1 = __importDefault(require("./createModel"));
 exports.createModel = createModel_1.default;
-const modelToSchema_1 = __importDefault(require("./createModel/modelToSchema"));
-exports.modelToSchema = modelToSchema_1.default;
+const modelToSchema_1 = require("./createModel/modelToSchema");
+Object.defineProperty(exports, "modelToSchema", { enumerable: true, get: function () { return modelToSchema_1.modelToSchema; } });
+Object.defineProperty(exports, "modelToSchemaWithModel", { enumerable: true, get: function () { return modelToSchema_1.modelToSchemaWithModel; } });
 __exportStar(require("./types"), exports);

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>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/models",
-  "version": "3.0.24",
+  "version": "3.0.31",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -17,15 +17,15 @@
     "upgrade-interactive": "yarn upgrade-interactive"
   },
   "dependencies": {
-    "@orion-js/helpers": "^3.0.17",
-    "@orion-js/resolvers": "^3.0.24",
-    "@orion-js/schema": "^3.0.17"
+    "@orion-js/helpers": "^3.0.31",
+    "@orion-js/resolvers": "^3.0.31",
+    "@orion-js/schema": "^3.0.31"
   },
   "peerDependencies": {
     "@orion-js/cache": "^3.0.0-alpha.10"
   },
   "devDependencies": {
-    "@orion-js/cache": "^3.0.17",
+    "@orion-js/cache": "^3.0.31",
     "@shelf/jest-mongodb": "^2.1.0",
     "@types/jest": "^27.0.2",
     "@types/lodash": "4.14.176",
@@ -36,5 +36,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5ac1c68e72af3dbeaf8eb5c2a04d5325da2a7e3f"
+  "gitHead": "8d1f8b92ea815c14ffeaecfa8879ca775bc1d991"
 }