@twin.org/auditable-item-graph-models 0.0.2-next.8 → 0.0.3-next.0

package/dist/es/schemas/AuditableItemGraphEdge.json

@@ -0,0 +1,73 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/aig/AuditableItemGraphEdge",
+    "description": "Interface describing an edge between two vertices in an auditable item graph.",
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "description": "The id of the element."
+        },
+        "dateCreated": {
+            "type": "string",
+            "description": "The date/time of when the element was created."
+        },
+        "dateModified": {
+            "type": "string",
+            "description": "The date/time of when the element was modified."
+        },
+        "dateDeleted": {
+            "type": "string",
+            "description": "The date/time of when the element was deleted, as we never actually remove items."
+        },
+        "@context": {
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://schema.twindev.org/aig/"
+                },
+                {
+                    "type": "array",
+                    "minItems": 1,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://schema.twindev.org/aig/"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ],
+            "description": "JSON-LD Context."
+        },
+        "targetId": {
+            "type": "string",
+            "description": "The target vertex id the edge connects to."
+        },
+        "type": {
+            "type": "string",
+            "const": "AuditableItemGraphEdge",
+            "description": "JSON-LD Type."
+        },
+        "annotationObject": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+            "description": "The JSON-LD annotation object for the edge."
+        },
+        "edgeRelationships": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "description": "The relationships between the two vertices."
+        }
+    },
+    "required": [
+        "@context",
+        "targetId",
+        "type",
+        "edgeRelationships"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/AuditableItemGraphPatchOperation.json

@@ -0,0 +1,65 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/aig/AuditableItemGraphPatchOperation",
+    "description": "The patch operation for JSON diffs.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://schema.twindev.org/aig/"
+                },
+                {
+                    "type": "array",
+                    "minItems": 1,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://schema.twindev.org/aig/"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ],
+            "description": "JSON-LD Context."
+        },
+        "type": {
+            "type": "string",
+            "const": "AuditableItemGraphPatchOperation",
+            "description": "JSON-LD Type."
+        },
+        "patchOperation": {
+            "type": "string",
+            "enum": [
+                "add",
+                "remove",
+                "replace",
+                "move",
+                "copy",
+                "test"
+            ],
+            "description": "The operation that was performed on the item."
+        },
+        "patchPath": {
+            "type": "string",
+            "description": "The path to the object that was changed."
+        },
+        "patchFrom": {
+            "type": "string",
+            "description": "The path the value was copied or moved from."
+        },
+        "patchValue": {
+            "description": "The value to add."
+        }
+    },
+    "required": [
+        "@context",
+        "type",
+        "patchOperation",
+        "patchPath"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/AuditableItemGraphResource.json

@@ -0,0 +1,60 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/aig/AuditableItemGraphResource",
+    "description": "Interface describing an auditable item graph vertex resource.",
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "description": "The id of the element."
+        },
+        "dateCreated": {
+            "type": "string",
+            "description": "The date/time of when the element was created."
+        },
+        "dateModified": {
+            "type": "string",
+            "description": "The date/time of when the element was modified."
+        },
+        "dateDeleted": {
+            "type": "string",
+            "description": "The date/time of when the element was deleted, as we never actually remove items."
+        },
+        "@context": {
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://schema.twindev.org/aig/"
+                },
+                {
+                    "type": "array",
+                    "minItems": 1,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://schema.twindev.org/aig/"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ],
+            "description": "JSON-LD Context."
+        },
+        "type": {
+            "type": "string",
+            "const": "AuditableItemGraphResource",
+            "description": "JSON-LD Type."
+        },
+        "resourceObject": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+            "description": "The JSON-LD object for the resource."
+        }
+    },
+    "required": [
+        "@context",
+        "type"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/AuditableItemGraphVertex.json

@@ -0,0 +1,93 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/aig/AuditableItemGraphVertex",
+    "description": "Interface describing an auditable item graph vertex.",
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "description": "The id of the element."
+        },
+        "dateCreated": {
+            "type": "string",
+            "description": "The date/time of when the element was created."
+        },
+        "dateModified": {
+            "type": "string",
+            "description": "The date/time of when the element was modified."
+        },
+        "dateDeleted": {
+            "type": "string",
+            "description": "The date/time of when the element was deleted, as we never actually remove items."
+        },
+        "@context": {
+            "type": "array",
+            "minItems": 2,
+            "description": "JSON-LD Context.",
+            "prefixItems": [
+                {
+                    "type": "string",
+                    "const": "https://schema.twindev.org/aig/"
+                },
+                {
+                    "type": "string",
+                    "const": "https://schema.twindev.org/common/"
+                }
+            ],
+            "items": {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+            }
+        },
+        "type": {
+            "type": "string",
+            "const": "AuditableItemGraphVertex",
+            "description": "JSON-LD Type."
+        },
+        "organizationIdentity": {
+            "type": "string",
+            "description": "The identity of the organization which controls the vertex."
+        },
+        "annotationObject": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+            "description": "The JSON-LD annotation object for the vertex."
+        },
+        "aliases": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/aig/AuditableItemGraphAlias"
+            },
+            "description": "Alternative aliases that can be used to identify the vertex."
+        },
+        "resources": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/aig/AuditableItemGraphResource"
+            },
+            "description": "The resources attached to the vertex."
+        },
+        "edges": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/aig/AuditableItemGraphEdge"
+            },
+            "description": "Edges connected to the vertex."
+        },
+        "changesets": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/aig/AuditableItemGraphChangeset"
+            },
+            "description": "Changesets for the vertex."
+        },
+        "verified": {
+            "type": "boolean",
+            "description": "Is the vertex verified, will only be populated when verification is requested."
+        }
+    },
+    "required": [
+        "@context",
+        "id",
+        "type"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/AuditableItemGraphVertexList.json

@@ -0,0 +1,59 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/aig/AuditableItemGraphVertexList",
+    "description": "Interface describing an auditable item graph vertex list.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "type": "array",
+            "minItems": 2,
+            "description": "JSON-LD Context.",
+            "prefixItems": [
+                {
+                    "type": "string",
+                    "const": "https://schema.org"
+                },
+                {
+                    "type": "string",
+                    "const": "https://schema.twindev.org/aig/"
+                }
+            ],
+            "items": {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+            }
+        },
+        "type": {
+            "type": "array",
+            "items": {
+                "allOf": [
+                    {
+                        "type": "string",
+                        "const": "ItemList"
+                    },
+                    {
+                        "type": "string",
+                        "const": "AuditableItemGraphVertexList"
+                    }
+                ]
+            },
+            "description": "JSON-LD Type."
+        },
+        "itemListElement": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/aig/AuditableItemGraphVertex"
+            },
+            "description": "The list of vertices."
+        },
+        "nextItem": {
+            "type": "string",
+            "description": "The cursor to get the next chunk of vertices."
+        }
+    },
+    "required": [
+        "@context",
+        "type",
+        "itemListElement"
+    ],
+    "additionalProperties": false
+}

package/dist/types/index.d.ts

@@ -1,22 +1,22 @@
-export * from "./dataTypes/auditableItemGraphDataTypes";
-export * from "./models/api/IAuditableItemGraphCreateRequest";
-export * from "./models/api/IAuditableItemGraphGetRequest";
-export * from "./models/api/IAuditableItemGraphGetResponse";
-export * from "./models/api/IAuditableItemGraphListRequest";
-export * from "./models/api/IAuditableItemGraphListResponse";
-export * from "./models/api/IAuditableItemGraphUpdateRequest";
-export * from "./models/auditableItemGraphContexts";
-export * from "./models/auditableItemGraphTopics";
-export * from "./models/auditableItemGraphTypes";
-export * from "./models/eventBus/IAuditableItemGraphEventBusVertexCreated";
-export * from "./models/eventBus/IAuditableItemGraphEventBusVertexUpdated";
-export * from "./models/IAuditableItemGraphAlias";
-export * from "./models/IAuditableItemGraphAuditedElement";
-export * from "./models/IAuditableItemGraphChangeset";
-export * from "./models/IAuditableItemGraphComponent";
-export * from "./models/IAuditableItemGraphEdge";
-export * from "./models/IAuditableItemGraphPatchOperation";
-export * from "./models/IAuditableItemGraphResource";
-export * from "./models/IAuditableItemGraphVertex";
-export * from "./models/IAuditableItemGraphVertexList";
-export * from "./models/verifyDepth";
+export * from "./dataTypes/auditableItemGraphDataTypes.js";
+export * from "./models/api/IAuditableItemGraphCreateRequest.js";
+export * from "./models/api/IAuditableItemGraphGetRequest.js";
+export * from "./models/api/IAuditableItemGraphGetResponse.js";
+export * from "./models/api/IAuditableItemGraphListRequest.js";
+export * from "./models/api/IAuditableItemGraphListResponse.js";
+export * from "./models/api/IAuditableItemGraphUpdateRequest.js";
+export * from "./models/auditableItemGraphContexts.js";
+export * from "./models/auditableItemGraphTopics.js";
+export * from "./models/auditableItemGraphTypes.js";
+export * from "./models/eventBus/IAuditableItemGraphEventBusVertexCreated.js";
+export * from "./models/eventBus/IAuditableItemGraphEventBusVertexUpdated.js";
+export * from "./models/IAuditableItemGraphAlias.js";
+export * from "./models/IAuditableItemGraphAuditedElement.js";
+export * from "./models/IAuditableItemGraphChangeset.js";
+export * from "./models/IAuditableItemGraphComponent.js";
+export * from "./models/IAuditableItemGraphEdge.js";
+export * from "./models/IAuditableItemGraphPatchOperation.js";
+export * from "./models/IAuditableItemGraphResource.js";
+export * from "./models/IAuditableItemGraphVertex.js";
+export * from "./models/IAuditableItemGraphVertexList.js";
+export * from "./models/verifyDepth.js";

package/dist/types/models/IAuditableItemGraphAlias.d.ts

@@ -1,7 +1,7 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
-import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
-import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement.js";
 /**
  * Interface describing an alias for a vertex.
  */

package/dist/types/models/IAuditableItemGraphChangeset.d.ts

@@ -1,8 +1,8 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
 import type { IImmutableProofVerification } from "@twin.org/immutable-proof-models";
-import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
-import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
-import type { IAuditableItemGraphPatchOperation } from "./IAuditableItemGraphPatchOperation";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphPatchOperation } from "./IAuditableItemGraphPatchOperation.js";
 /**
  * Interface describing a set of changes to the vertex.
  */
@@ -30,7 +30,7 @@ export interface IAuditableItemGraphChangeset {
     /**
      * The user identity that created the changes.
      */
-    userIdentity: string;
+    userIdentity?: string;
     /**
      * The patches in the changeset.
      */

package/dist/types/models/IAuditableItemGraphComponent.d.ts

@@ -1,9 +1,9 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { IComparator, SortDirection } from "@twin.org/entity";
-import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex";
-import type { IAuditableItemGraphVertexList } from "./IAuditableItemGraphVertexList";
-import type { VerifyDepth } from "./verifyDepth";
+import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex.js";
+import type { IAuditableItemGraphVertexList } from "./IAuditableItemGraphVertexList.js";
+import type { VerifyDepth } from "./verifyDepth.js";
 /**
  * Interface describing an auditable item graph contract.
  */
@@ -15,8 +15,6 @@ export interface IAuditableItemGraphComponent extends IComponent {
      * @param vertex.aliases Alternative aliases that can be used to identify the vertex.
      * @param vertex.resources The resources attached to the vertex.
      * @param vertex.edges The edges connected to the vertex.
-     * @param userIdentity The identity to create the auditable item graph operation with.
-     * @param nodeIdentity The node identity to use for vault operations.
      * @returns The id of the new graph item.
      */
     create(vertex: {
@@ -36,7 +34,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
             edgeRelationships: string[];
             annotationObject?: IJsonLdNodeObject;
         }[];
-    }, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    }): Promise<string>;
     /**
      * Update a graph vertex.
      * @param vertex The vertex to update.
@@ -45,8 +43,6 @@ export interface IAuditableItemGraphComponent extends IComponent {
      * @param vertex.aliases Alternative aliases that can be used to identify the vertex.
      * @param vertex.resources The resources attached to the vertex.
      * @param vertex.edges The edges connected to the vertex.
-     * @param userIdentity The identity to create the auditable item graph operation with.
-     * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      */
     update(vertex: {
@@ -68,7 +64,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
             edgeRelationships: string[];
             annotationObject?: IJsonLdNodeObject;
         }[];
-    }, userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    }): Promise<void>;
     /**
      * Get a graph vertex.
      * @param id The id of the vertex to get.
@@ -87,11 +83,10 @@ export interface IAuditableItemGraphComponent extends IComponent {
     /**
      * Remove the verifiable storage for an item.
      * @param id The id of the vertex to remove the storage from.
-     * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      * @throws NotFoundError if the vertex is not found.
      */
-    removeVerifiable(id: string, nodeIdentity?: string): Promise<void>;
+    removeVerifiable(id: string): Promise<void>;
     /**
      * Query the graph for vertices.
      * @param options The query options.

package/dist/types/models/IAuditableItemGraphEdge.d.ts

@@ -1,7 +1,7 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
-import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
-import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement.js";
 /**
  * Interface describing an edge between two vertices in an auditable item graph.
  */

package/dist/types/models/IAuditableItemGraphPatchOperation.d.ts

@@ -1,6 +1,6 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
-import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
-import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
 /**
  * The patch operation for JSON diffs.
  */

package/dist/types/models/IAuditableItemGraphResource.d.ts

@@ -1,7 +1,7 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
-import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
-import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement.js";
 /**
  * Interface describing an auditable item graph vertex resource.
  */

package/dist/types/models/IAuditableItemGraphVertex.d.ts

@@ -1,11 +1,11 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
-import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
-import type { IAuditableItemGraphAlias } from "./IAuditableItemGraphAlias";
-import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
-import type { IAuditableItemGraphChangeset } from "./IAuditableItemGraphChangeset";
-import type { IAuditableItemGraphEdge } from "./IAuditableItemGraphEdge";
-import type { IAuditableItemGraphResource } from "./IAuditableItemGraphResource";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphAlias } from "./IAuditableItemGraphAlias.js";
+import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement.js";
+import type { IAuditableItemGraphChangeset } from "./IAuditableItemGraphChangeset.js";
+import type { IAuditableItemGraphEdge } from "./IAuditableItemGraphEdge.js";
+import type { IAuditableItemGraphResource } from "./IAuditableItemGraphResource.js";
 /**
  * Interface describing an auditable item graph vertex.
  */
@@ -27,9 +27,9 @@ export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAudit
      */
     type: typeof AuditableItemGraphTypes.Vertex;
     /**
-     * The identity of the node which controls the vertex.
+     * The identity of the organization which controls the vertex.
      */
-    nodeIdentity?: string;
+    organizationIdentity?: string;
     /**
      * The JSON-LD annotation object for the vertex.
      */

package/dist/types/models/IAuditableItemGraphVertexList.d.ts

@@ -1,8 +1,8 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
 import type { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
-import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
-import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
-import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex.js";
 /**
  * Interface describing an auditable item graph vertex list.
  */

package/dist/types/models/api/IAuditableItemGraphGetRequest.d.ts

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { VerifyDepth } from "../verifyDepth";
+import type { VerifyDepth } from "../verifyDepth.js";
 /**
  * Get an auditable item graph vertex.
  */

package/dist/types/models/api/IAuditableItemGraphGetResponse.d.ts

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex";
+import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex.js";
 /**
  * Response to getting an auditable item graph vertex.
  */

package/dist/types/models/api/IAuditableItemGraphListRequest.d.ts

@@ -1,6 +1,6 @@
 import type { SortDirection } from "@twin.org/entity";
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex";
+import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex.js";
 /**
  * Get the a list of the vertices with matching ids or aliases.
  */

package/dist/types/models/api/IAuditableItemGraphListResponse.d.ts

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IAuditableItemGraphVertexList } from "../IAuditableItemGraphVertexList";
+import type { IAuditableItemGraphVertexList } from "../IAuditableItemGraphVertexList.js";
 /**
  * The response to getting the a list of the vertices with matching ids or aliases.
  */

package/docs/reference/interfaces/IAuditableItemGraphChangeset.md

@@ -36,9 +36,9 @@ The date/time of when the changeset was created.
 
 ***
 
-### userIdentity
+### userIdentity?
 
-> **userIdentity**: `string`
+> `optional` **userIdentity**: `string`
 
 The user identity that created the changes.