@orion-js/models 3.0.24 → 3.0.26

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)
@@ -24,11 +25,11 @@ const createModel = modelOptions => {
     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.default)(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.js

@@ -22,7 +22,9 @@ function default_1(schema, model) {
         return schema;
     return {
         ...schema,
-        __model: model
+        __model: model,
+        __validate: model.validate,
+        __clean: model.clean
     };
 }
 exports.default = default_1;

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/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.26",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -36,5 +36,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5ac1c68e72af3dbeaf8eb5c2a04d5325da2a7e3f"
+  "gitHead": "1a23db17e115fe86aefce8f496b063ecaa7d37e7"
 }