rads-db 3.0.24 → 3.0.25

package/dist/index.cjs

@@ -543,12 +543,12 @@ async function fillDenormFieldsBeforePut(computedContext, docUpdates, ctx) {
   await Promise.all(promises);
 }
 
-function cleanUndefinedAndNull(obj) {
+function cleanUndefinedAndNull(obj, isChange = false) {
   for (const key in obj) {
-    if (obj[key] == null)
+    if (obj[key] == null && !isChange)
       delete obj[key];
     if (___default.isPlainObject(obj[key]))
-      cleanUndefinedAndNull(obj[key]);
+      cleanUndefinedAndNull(obj[key], key === "change");
   }
 }
 
@@ -607,7 +607,6 @@ function mustUseDeepDiff(value, oldValue) {
 
 function getRadsDbMethods(key, computedContext, driverInstance) {
   const { schema, options, validators } = computedContext;
-  const mustCleanNulls = driverInstance.driverName !== "restApi";
   const { precomputedFields } = schema[key];
   async function getMany(args, ctx) {
     args = { ...args, where: { ...args?.where } };
@@ -639,7 +638,7 @@ function getRadsDbMethods(key, computedContext, driverInstance) {
     const docArgsToSave = docs.map((doc) => {
       const oldDoc = oldDocsById[doc.id];
       doc = merge(oldDoc, doc);
-      if (mustCleanNulls)
+      if (!options.keepNulls)
         cleanUndefinedAndNull(doc);
       return { oldDoc, doc };
     });
@@ -717,7 +716,7 @@ function getRadsDbMethods(key, computedContext, driverInstance) {
       const oldDoc = await driverInstance.get({ where: { id: doc.id } }, ctx);
       if (oldDoc)
         doc = merge(oldDoc, doc);
-      if (mustCleanNulls)
+      if (!options.keepNulls)
         cleanUndefinedAndNull(doc);
       const docArgsToSave = [{ doc, oldDoc }];
       await handlePrecomputed(computedContext, docArgsToSave, ctx);
@@ -759,7 +758,7 @@ function getRadsDbMethods(key, computedContext, driverInstance) {
             delete doc[p];
           }
         }
-        if (mustCleanNulls)
+        if (!options.keepNulls)
           cleanUndefinedAndNull(doc);
         return { oldDoc, doc };
       });
@@ -1138,6 +1137,7 @@ function createRadsDbClient(args) {
     ...args,
     noComputed: true,
     noCustomDrivers: true,
+    keepNulls: true,
     driver: restApi(args?.driver)
   };
   const s = radsDbArgs.schema || _radsDb.schema;
@@ -1145,6 +1145,7 @@ function createRadsDbClient(args) {
   return generateMethods(s, validators, radsDbArgs);
 }
 
+exports.cleanUndefinedAndNull = cleanUndefinedAndNull;
 exports.computed = computed;
 exports.createRadsDb = createRadsDb;
 exports.createRadsDbClient = createRadsDbClient;

package/dist/index.d.ts

@@ -186,6 +186,7 @@ interface CreateRadsDbArgs {
     beforeGet?: (args: GetArgsAny, ctx: RadsRequestContext, context: ComputedContext) => MaybePromise<void>;
     context?: Record<string, any> & Omit<RadsRequestContext, 'dryRun' | 'silent'>;
     features?: RadsFeature[];
+    keepNulls?: boolean;
 }
 type CreateRadsDbArgsNormalized = RequiredFields<CreateRadsDbArgs, 'computed' | 'features'> & {
     driver: CreateRadsArgsDrivers;
@@ -393,6 +394,8 @@ declare function merge<T extends Record<string, any>>(target: T, source: any): T
 
 declare function diff(object: any, base: any, includeDenormFields?: boolean): any;
 
+declare function cleanUndefinedAndNull(obj: Record<string, any>, isChange?: boolean): void;
+
 /**
  * Creates instance of rads db - object that provides access to all entities.
  * Intended to be used on the backend. On the client you may want to opt for "createRadsDbClient" instead.
@@ -405,4 +408,4 @@ declare function createRadsDb(args?: CreateRadsDbArgs): RadsDb;
  */
 declare function createRadsDbClient(args?: CreateRadsDbClientArgs): RadsDb;
 
-export { Change, ComputedContext, ComputedContextGlobal, ComputedDecoratorArgs, CreateRadsArgsDrivers, CreateRadsDbArgs, CreateRadsDbArgsNormalized, CreateRadsDbClientArgs, DeepPartial, Driver, DriverConstructor, EntityDecoratorArgs, EntityMethods, EnumDefinition, FieldDecoratorArgs, FieldDefinition, FileSystemNode, FileUploadArgs, FileUploadDriver, FileUploadResult, GenerateClientNormalizedOptions, GenerateClientOptions, GetAggArgs, GetAggArgsAgg, GetAggArgsAny, GetAggResponse, GetArgs, GetArgsAny, GetArgsInclude, GetManyArgs, GetManyArgsAny, GetManyResponse, GetResponse, GetResponseInclude, GetResponseIncludeSelect, GetResponseNoInclude, GetRestRoutesArgs, GetRestRoutesOptions, GetRestRoutesResponse, MinimalDriver, PutArgs, PutEffect, RadsFeature, RadsRequestContext, RadsUiSlotDefinition, RadsUiSlotName, RadsVitePluginOptions, Relation, RequiredFields, RestDriverOptions, RestFileUploadDriverOptions, Schema, SchemaValidators, TypeDefinition, UiDecoratorArgs, UiFieldDecoratorArgs, ValidateEntityDecoratorArgs, ValidateFieldDecoratorArgs, ValidateStringDecoratorArgs, VerifyManyArgs, VerifyManyArgsAny, VerifyManyResponse, computed, createRadsDb, createRadsDbClient, diff, entity, field, getDriverInstance, handlePrecomputed, merge, precomputed, ui, validate };
+export { Change, ComputedContext, ComputedContextGlobal, ComputedDecoratorArgs, CreateRadsArgsDrivers, CreateRadsDbArgs, CreateRadsDbArgsNormalized, CreateRadsDbClientArgs, DeepPartial, Driver, DriverConstructor, EntityDecoratorArgs, EntityMethods, EnumDefinition, FieldDecoratorArgs, FieldDefinition, FileSystemNode, FileUploadArgs, FileUploadDriver, FileUploadResult, GenerateClientNormalizedOptions, GenerateClientOptions, GetAggArgs, GetAggArgsAgg, GetAggArgsAny, GetAggResponse, GetArgs, GetArgsAny, GetArgsInclude, GetManyArgs, GetManyArgsAny, GetManyResponse, GetResponse, GetResponseInclude, GetResponseIncludeSelect, GetResponseNoInclude, GetRestRoutesArgs, GetRestRoutesOptions, GetRestRoutesResponse, MinimalDriver, PutArgs, PutEffect, RadsFeature, RadsRequestContext, RadsUiSlotDefinition, RadsUiSlotName, RadsVitePluginOptions, Relation, RequiredFields, RestDriverOptions, RestFileUploadDriverOptions, Schema, SchemaValidators, TypeDefinition, UiDecoratorArgs, UiFieldDecoratorArgs, ValidateEntityDecoratorArgs, ValidateFieldDecoratorArgs, ValidateStringDecoratorArgs, VerifyManyArgs, VerifyManyArgsAny, VerifyManyResponse, cleanUndefinedAndNull, computed, createRadsDb, createRadsDbClient, diff, entity, field, getDriverInstance, handlePrecomputed, merge, precomputed, ui, validate };

package/dist/index.mjs

@@ -535,12 +535,12 @@ async function fillDenormFieldsBeforePut(computedContext, docUpdates, ctx) {
   await Promise.all(promises);
 }
 
-function cleanUndefinedAndNull(obj) {
+function cleanUndefinedAndNull(obj, isChange = false) {
   for (const key in obj) {
-    if (obj[key] == null)
+    if (obj[key] == null && !isChange)
       delete obj[key];
     if (_.isPlainObject(obj[key]))
-      cleanUndefinedAndNull(obj[key]);
+      cleanUndefinedAndNull(obj[key], key === "change");
   }
 }
 
@@ -599,7 +599,6 @@ function mustUseDeepDiff(value, oldValue) {
 
 function getRadsDbMethods(key, computedContext, driverInstance) {
   const { schema, options, validators } = computedContext;
-  const mustCleanNulls = driverInstance.driverName !== "restApi";
   const { precomputedFields } = schema[key];
   async function getMany(args, ctx) {
     args = { ...args, where: { ...args?.where } };
@@ -631,7 +630,7 @@ function getRadsDbMethods(key, computedContext, driverInstance) {
     const docArgsToSave = docs.map((doc) => {
       const oldDoc = oldDocsById[doc.id];
       doc = merge(oldDoc, doc);
-      if (mustCleanNulls)
+      if (!options.keepNulls)
         cleanUndefinedAndNull(doc);
       return { oldDoc, doc };
     });
@@ -709,7 +708,7 @@ function getRadsDbMethods(key, computedContext, driverInstance) {
       const oldDoc = await driverInstance.get({ where: { id: doc.id } }, ctx);
       if (oldDoc)
         doc = merge(oldDoc, doc);
-      if (mustCleanNulls)
+      if (!options.keepNulls)
         cleanUndefinedAndNull(doc);
       const docArgsToSave = [{ doc, oldDoc }];
       await handlePrecomputed(computedContext, docArgsToSave, ctx);
@@ -751,7 +750,7 @@ function getRadsDbMethods(key, computedContext, driverInstance) {
             delete doc[p];
           }
         }
-        if (mustCleanNulls)
+        if (!options.keepNulls)
           cleanUndefinedAndNull(doc);
         return { oldDoc, doc };
       });
@@ -1130,6 +1129,7 @@ function createRadsDbClient(args) {
     ...args,
     noComputed: true,
     noCustomDrivers: true,
+    keepNulls: true,
     driver: restApi(args?.driver)
   };
   const s = radsDbArgs.schema || schema;
@@ -1137,4 +1137,4 @@ function createRadsDbClient(args) {
   return generateMethods(s, validators, radsDbArgs);
 }
 
-export { computed, createRadsDb, createRadsDbClient, diff, entity, field, getDriverInstance, handlePrecomputed, merge, precomputed, ui, validate };
+export { cleanUndefinedAndNull, computed, createRadsDb, createRadsDbClient, diff, entity, field, getDriverInstance, handlePrecomputed, merge, precomputed, ui, validate };

package/features/eventSourcing.cjs

@@ -62,13 +62,15 @@ function verifyEventSourcingSetup(schema, effects) {
           if (events.slice(1).some(ev => ev.type === "creation")) {
             throw new Error(`Only first event may have type = "creation"`);
           }
-          let aggDoc = {
-            id: aggId
-          };
+          let aggDoc;
           for (const ev of events) {
-            const newAggDoc = context.validators[entityName]((0, _radsDb.merge)(aggDoc, ev.change));
+            const newAggDoc = context.validators[entityName]((0, _radsDb.merge)(aggDoc || {
+              id: aggId
+            }, ev.change));
+            ev.beforeChange = aggDoc;
             ev.change = (0, _radsDb.diff)(newAggDoc, aggDoc);
             aggDoc = newAggDoc;
+            if (!context.options.keepNulls) (0, _radsDb.cleanUndefinedAndNull)(aggDoc);
           }
           result.push({
             aggDoc,
@@ -97,22 +99,55 @@ function validateEventSourcingSetup(schema, entityName, eventEntityName, aggrega
   if (!eventEntity) throw new Error(`You must create entity with name "${eventEntityName}" to use eventSourcing feature with "${entityName}"`);
   if (!eventEntity.decorators.entity) throw new Error(`"${eventEntityName}" must have "@entity()" decorator.`);
   const expectedFields = {
-    id: "string",
-    type: "enum",
-    change: entityName,
-    [aggregateRelationField]: entityName,
-    date: "string"
+    id: {
+      type: "string"
+    },
+    change: {
+      type: entityName,
+      isChange: true
+    },
+    type: {
+      isEnum: true
+    },
+    beforeChange: {
+      type: entityName,
+      isChange: false,
+      isRelation: false,
+      isRequired: false
+    },
+    [aggregateRelationField]: {
+      type: entityName,
+      isRelation: true
+    },
+    date: {
+      type: "string"
+    }
   };
   for (const f in expectedFields) {
-    const field = eventEntity.fields?.[f];
-    if (!field) throw new Error(`"${eventEntityName}" must have field "${f}"`);
-    if (expectedFields[f] === "enum") {
-      if (!schema[field.type]?.enumValues?.creation) throw new Error(`Field "${eventEntityName}.${f}" must be enum that accepts value 'creation'`);
-    } else {
-      if (field.type !== expectedFields[f]) throw new Error(`"${eventEntityName}.${f}" must have type "${expectedFields[f]}"`);
-      if (f === "change" && !field.isChange) {
-        throw new Error(`"${eventEntityName}.${f}" must have type "Change<${expectedFields[f]}>"`);
-      }
-    }
+    validateSchemaField(f, eventEntityName, expectedFields, schema);
+  }
+}
+function validateSchemaField(fieldName, eventEntityName, expectedFields, schema) {
+  const eventEntity = schema[eventEntityName];
+  const field = eventEntity.fields?.[fieldName];
+  if (!field) throw new Error(`"${eventEntityName}" must have field "${fieldName}"`);
+  const expectedField = expectedFields[fieldName];
+  if (expectedField.type && expectedField.type !== field.type) {
+    throw new Error(`"${eventEntityName}.${fieldName}" must have type "${expectedField.type}"`);
+  }
+  if (expectedField.isEnum) {
+    if (!schema[field.type]?.enumValues?.creation) throw new Error(`Field "${eventEntityName}.${fieldName}" must be enum that accepts value 'creation'`);
+  }
+  if (expectedField.isChange != null && expectedField.isChange !== (field.isChange || false)) {
+    const expectedType = expectedField.isChange ? `Change<${expectedField.type}>` : expectedField.type;
+    throw new Error(`"${eventEntityName}.${fieldName}" must have type "${expectedType}"`);
+  }
+  if (expectedField.isRelation != null && expectedField.isRelation !== (field.isRelation || false)) {
+    const expectedType = expectedField.isRelation ? `Relation<${expectedField.type}>` : expectedField.type;
+    throw new Error(`"${eventEntityName}.${fieldName}" must have type "${expectedType}"`);
+  }
+  if (expectedField.isRequired != null && expectedField.isRequired !== (field.isRequired || false)) {
+    const expectedRequired = expectedField.isRequired ? `required` : "optional";
+    throw new Error(`"${eventEntityName}.${fieldName}" must be ${expectedRequired}`);
   }
 }

package/features/eventSourcing.mjs

@@ -1,5 +1,5 @@
 import _ from "lodash";
-import { diff, handlePrecomputed, merge } from "rads-db";
+import { cleanUndefinedAndNull, diff, handlePrecomputed, merge } from "rads-db";
 export default () => {
   return {
     name: "eventSourcing",
@@ -58,11 +58,14 @@ function verifyEventSourcingSetup(schema, effects) {
           if (events.slice(1).some((ev) => ev.type === "creation")) {
             throw new Error(`Only first event may have type = "creation"`);
           }
-          let aggDoc = { id: aggId };
+          let aggDoc;
           for (const ev of events) {
-            const newAggDoc = context.validators[entityName](merge(aggDoc, ev.change));
+            const newAggDoc = context.validators[entityName](merge(aggDoc || { id: aggId }, ev.change));
+            ev.beforeChange = aggDoc;
             ev.change = diff(newAggDoc, aggDoc);
             aggDoc = newAggDoc;
+            if (!context.options.keepNulls)
+              cleanUndefinedAndNull(aggDoc);
           }
           result.push({ aggDoc, events });
         }
@@ -89,25 +92,40 @@ function validateEventSourcingSetup(schema, entityName, eventEntityName, aggrega
   if (!eventEntity.decorators.entity)
     throw new Error(`"${eventEntityName}" must have "@entity()" decorator.`);
   const expectedFields = {
-    id: "string",
-    type: "enum",
-    change: entityName,
-    [aggregateRelationField]: entityName,
-    date: "string"
+    id: { type: "string" },
+    change: { type: entityName, isChange: true },
+    type: { isEnum: true },
+    beforeChange: { type: entityName, isChange: false, isRelation: false, isRequired: false },
+    [aggregateRelationField]: { type: entityName, isRelation: true },
+    date: { type: "string" }
   };
   for (const f in expectedFields) {
-    const field = eventEntity.fields?.[f];
-    if (!field)
-      throw new Error(`"${eventEntityName}" must have field "${f}"`);
-    if (expectedFields[f] === "enum") {
-      if (!schema[field.type]?.enumValues?.creation)
-        throw new Error(`Field "${eventEntityName}.${f}" must be enum that accepts value 'creation'`);
-    } else {
-      if (field.type !== expectedFields[f])
-        throw new Error(`"${eventEntityName}.${f}" must have type "${expectedFields[f]}"`);
-      if (f === "change" && !field.isChange) {
-        throw new Error(`"${eventEntityName}.${f}" must have type "Change<${expectedFields[f]}>"`);
-      }
-    }
+    validateSchemaField(f, eventEntityName, expectedFields, schema);
+  }
+}
+function validateSchemaField(fieldName, eventEntityName, expectedFields, schema) {
+  const eventEntity = schema[eventEntityName];
+  const field = eventEntity.fields?.[fieldName];
+  if (!field)
+    throw new Error(`"${eventEntityName}" must have field "${fieldName}"`);
+  const expectedField = expectedFields[fieldName];
+  if (expectedField.type && expectedField.type !== field.type) {
+    throw new Error(`"${eventEntityName}.${fieldName}" must have type "${expectedField.type}"`);
+  }
+  if (expectedField.isEnum) {
+    if (!schema[field.type]?.enumValues?.creation)
+      throw new Error(`Field "${eventEntityName}.${fieldName}" must be enum that accepts value 'creation'`);
+  }
+  if (expectedField.isChange != null && expectedField.isChange !== (field.isChange || false)) {
+    const expectedType = expectedField.isChange ? `Change<${expectedField.type}>` : expectedField.type;
+    throw new Error(`"${eventEntityName}.${fieldName}" must have type "${expectedType}"`);
+  }
+  if (expectedField.isRelation != null && expectedField.isRelation !== (field.isRelation || false)) {
+    const expectedType = expectedField.isRelation ? `Relation<${expectedField.type}>` : expectedField.type;
+    throw new Error(`"${eventEntityName}.${fieldName}" must have type "${expectedType}"`);
+  }
+  if (expectedField.isRequired != null && expectedField.isRequired !== (field.isRequired || false)) {
+    const expectedRequired = expectedField.isRequired ? `required` : "optional";
+    throw new Error(`"${eventEntityName}.${fieldName}" must be ${expectedRequired}`);
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rads-db",
-  "version": "3.0.24",
+  "version": "3.0.25",
   "files": [
     "dist",
     "drivers",
@@ -107,7 +107,7 @@
     "test": "vitest --run && vitest typecheck --run",
     "link-rads-db": "symlink-dir ./test/_rads-db ./node_modules/_rads-db",
     "generate-test-schema": "rads-db",
-    "dev": "pnpm install && pnpm build && pnpm generate-test-schema && pnpm link-rads-db && vitest --ui --test-timeout 300000",
+    "dev": "pnpm install && pnpm link-rads-db && pnpm build && pnpm generate-test-schema && vitest --ui --test-timeout 300000",
     "lint": "cross-env NODE_ENV=production eslint src/**/*.* test/**/*.*",
     "dev-typecheck": "pnpm install && pnpm build && pnpm generate-test-schema && pnpm link-rads-db && vitest typecheck --ui",
     "build": "unbuild"