@orion-js/schema 3.1.6 → 3.2.0

package/lib/clean/index.d.ts

@@ -1,2 +1,2 @@
-import { CurrentNodeInfoOptions, Schema } from '../types/schema';
-export default function clean(schema: Schema | Function, doc?: {}, opts?: CurrentNodeInfoOptions, ...args: any[]): Promise<Schema>;
+import { Blackbox, CurrentNodeInfoOptions, Schema } from '../types/schema';
+export default function clean<TDoc = Blackbox>(schema: Schema | Function, doc: TDoc, opts?: CurrentNodeInfoOptions, ...args: any[]): Promise<TDoc>;

package/lib/clean/index.js

@@ -11,7 +11,9 @@ const defaultOptions = {
     trimStrings: true,
     removeEmptyStrings: false
 };
-async function clean(schema, doc = {}, opts = {}, ...args) {
+async function clean(schema, doc, opts = {}, ...args) {
+    if (!doc)
+        return doc;
     schema = (0, getSchemaFromTypedModel_1.getSchemaFromTypedModel)(schema);
     const options = { ...defaultOptions, ...opts };
     const params = {

package/lib/clean/index.test.js

@@ -143,7 +143,7 @@ test('run autovalue when field is not present', async () => {
     const schema = {
         text: {
             type: String,
-            autoValue(values) {
+            autoValue() {
                 return 'a value';
             }
         }
@@ -266,7 +266,7 @@ test('perform custom cleaning', async () => {
             type: [person]
         }
     };
-    // @ts-ignore TODO: Check why the __clean method is being used here instead of clean
+    // TODO: Check why the __clean method is being used here instead of clean
     const cleaned = await (0, index_1.default)(schema, {
         persons: [{ name: 'Nicolás' }, { name: 'Joaquin' }]
     });
@@ -288,7 +288,7 @@ test('perform non deep custom cleaning', async () => {
             }
         }
     };
-    // @ts-ignore TODO: Check why the __clean method is being used here instead of clean
+    // TODO: Check why the __clean method is being used here instead of clean
     const cleaned = await (0, index_1.default)(schema, { name: 'Joaquin' });
     expect(cleaned).toEqual({ name: 'Roberto' });
 });
@@ -296,7 +296,7 @@ test('Handle errors while cleaning', async () => {
     const schema = {
         name: {
             type: String,
-            async autoValue(value) {
+            async autoValue() {
                 throw new Error('an error');
             }
         }
@@ -347,7 +347,7 @@ test('omit undefined items in array', async () => {
             type: [item]
         }
     };
-    // @ts-ignore TODO: Check why the __clean method is being used here instead of clean
+    // TODO: Check why the __clean method is being used here instead of clean
     const result = await (0, index_1.default)(schema, doc);
     expect(result).toEqual({ items: [] });
 });
@@ -372,14 +372,14 @@ test('throws error when cleaning field with no type', async () => {
     const schema = {
         name: {
             type: null,
-            autoValue(name, info, arg1, arg2) {
+            autoValue() {
                 return 'Nicolás';
             }
         }
     };
     expect.assertions(1);
     try {
-        await (0, index_1.default)(schema);
+        await (0, index_1.default)(schema, {});
     }
     catch (error) {
         expect(error.message).toBe('Error cleaning field name, error: Cleaning field with no type');
@@ -389,12 +389,12 @@ test('cleans when no argument is passed', async () => {
     const schema = {
         name: {
             type: String,
-            autoValue(name, info, arg1, arg2) {
+            autoValue() {
                 return 'Nicolás';
             }
         }
     };
-    const result = await (0, index_1.default)(schema);
+    const result = await (0, index_1.default)(schema, {});
     expect(result).toEqual({ name: 'Nicolás' });
 });
 test('pass currentDoc cleaning complex schemas', async () => {
@@ -428,7 +428,7 @@ test('pass currentDoc cleaning complex schemas', async () => {
         },
         car: {
             type: car,
-            async autoValue(value, { currentDoc, doc }) {
+            async autoValue(value, { currentDoc }) {
                 expect(value).toEqual(aMom.car);
                 expect(currentDoc).toEqual(aMom);
                 return value;
@@ -464,7 +464,7 @@ test('pass currentDoc cleaning complex schemas', async () => {
         }
     };
     expect.assertions(14);
-    // @ts-ignore TODO: Check why the __clean method is being used here instead of clean
+    // TODO: Check why the __clean method is being used here instead of clean
     await (0, index_1.default)(schema, doc);
 });
 test('On blackbox allow use of custom clean', async () => {
@@ -472,7 +472,7 @@ test('On blackbox allow use of custom clean', async () => {
         info: {
             type: 'blackbox',
             optional: true,
-            async clean(info, { doc }) {
+            async clean() {
                 return { hello: 'world' };
             }
         }

package/lib/types/schema.d.ts

@@ -1,5 +1,8 @@
 import { FieldType } from '../fieldType';
 export declare type Constructor<T> = new (...args: any[]) => T;
+export declare type Blackbox = {
+    [name: string]: any;
+};
 export declare type FieldTypesList = 'string' | 'date' | 'integer' | 'number' | 'ID' | 'boolean' | 'email' | 'blackbox';
 export declare type TypedModelOnSchema = Function;
 export declare type ConstructorsTypesList = Constructor<String> | Constructor<Number> | Constructor<Boolean> | Constructor<Date>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/schema",
-  "version": "3.1.6",
+  "version": "3.2.0",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -36,5 +36,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "cb180a6a89ee2042f9d3dc80725f3aa05705a963"
+  "gitHead": "683cc5a018d45654ddf1299ea28e291fc7367dee"
 }