chore: add documentation for parameter

packages/stream-model-instance-handler/src/model-instance-document-handler.ts

@@ -195,7 +195,7 @@ export class ModelInstanceDocumentHandler implements StreamHandler<ModelInstance
     }
 
     const oldContent = state.content ?? {}
-    const newContent = jsonpatch.applyPatch(oldContent, payload.data, undefined, false).newDocument
+    const newContent = jsonpatch.applyPatch(oldContent, payload.data).newDocument
     const modelStream = await context.loadStream<Model>(metadata.model)
     const isDetType = deterministicTypes.includes(modelStream.content.accountRelation.type)
     const isFirstDataCommit = !state.log.some((c) => c.type === EventType.DATA)
@@ -249,8 +249,9 @@ export class ModelInstanceDocumentHandler implements StreamHandler<ModelInstance
    * Validates content against the schema of the model stream with given stream id
    * @param ceramic - Interface for reading streams from ceramic network
    * @param model - The model that this ModelInstanceDocument belongs to
-   * @param content - content to validate
-   * @param genesis - whether the commit being applied is a genesis commit
+   * @param content - Content to validate
+   * @param genesis - Whether the commit being applied is a genesis commit
+   * @param enforceImmutableFields - Whether the incoming commit is the first data commit for a model with deterministic creation (Optional)
    * @private
    */
   async _validateContent(
@@ -259,7 +260,7 @@ export class ModelInstanceDocumentHandler implements StreamHandler<ModelInstance
     content: any,
     genesis: boolean,
     payload?: Payload,
-    hasContent?: boolean
+    enforceImmutableFields?: boolean
   ): Promise<void> {
     if (
       genesis &&
@@ -280,7 +281,7 @@ export class ModelInstanceDocumentHandler implements StreamHandler<ModelInstance
 
     // Now validate the relations
     await this._validateRelationsContent(ceramic, model, content)
-    if (!genesis && payload && !hasContent) {
+    if (!genesis && payload && !enforceImmutableFields) {
       await this._validateLockedFieldsUpdate(model, payload)
     }
   }