@twin.org/auditable-item-graph-models 0.0.3-next.11 → 0.0.3-next.12

package/dist/es/schemas/AuditableItemGraphPatchOperation.json

@@ -1,58 +1,67 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "https://schema.twindev.org/aig/AuditableItemGraphPatchOperation",
+    "title": "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"
-                    }
+                    },
+                    "minItems": 1
                 }
             ],
             "description": "JSON-LD Context."
         },
         "type": {
-            "type": "string",
             "const": "AuditableItemGraphPatchOperation",
             "description": "JSON-LD Type."
         },
         "patchOperation": {
-            "type": "string",
-            "enum": [
-                "add",
-                "remove",
-                "replace",
-                "move",
-                "copy",
-                "test"
+            "anyOf": [
+                {
+                    "const": "add"
+                },
+                {
+                    "const": "remove"
+                },
+                {
+                    "const": "replace"
+                },
+                {
+                    "const": "move"
+                },
+                {
+                    "const": "copy"
+                },
+                {
+                    "const": "test"
+                }
             ],
-            "description": "The operation that was performed on the item. json-ld type:sch:Text"
+            "description": "The operation that was performed on the item."
         },
         "patchPath": {
             "type": "string",
-            "description": "The path to the object that was changed. json-ld type:sch:Text"
+            "description": "The path to the object that was changed."
         },
         "patchFrom": {
             "type": "string",
-            "description": "The path the value was copied or moved from. json-ld type:sch:Text"
+            "description": "The path the value was copied or moved from."
         },
         "patchValue": {
-            "description": "The value to add. json-ld type:json"
+            "description": "The value to add."
         }
     },
     "required": [

package/dist/es/schemas/AuditableItemGraphResource.json

@@ -1,59 +1,45 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "https://schema.twindev.org/aig/AuditableItemGraphResource",
+    "title": "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. json-ld namespace:sch"
-        },
-        "dateModified": {
-            "type": "string",
-            "description": "The date/time of when the element was modified. json-ld namespace:sch"
-        },
-        "dateDeleted": {
-            "type": "string",
-            "description": "The date/time of when the element was deleted, as we never actually remove items. json-ld namespace:sch"
-        },
         "@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"
-                    }
+                    },
+                    "minItems": 1
                 }
             ],
             "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. json-ld type:json"
+            "description": "The JSON-LD object for the resource."
         }
     },
     "required": [
-        "@context",
         "type"
+    ],
+    "allOf": [
+        {
+            "$ref": "https://schema.twindev.org/aig/AuditableItemGraphAuditedElement"
+        }
     ]
 }

package/dist/es/schemas/AuditableItemGraphVertex.json

@@ -1,85 +1,92 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "https://schema.twindev.org/aig/AuditableItemGraphVertex",
+    "title": "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. json-ld namespace:sch"
-        },
-        "dateModified": {
-            "type": "string",
-            "description": "The date/time of when the element was modified. json-ld namespace:sch"
-        },
-        "dateDeleted": {
-            "type": "string",
-            "description": "The date/time of when the element was deleted, as we never actually remove items. json-ld namespace:sch"
-        },
         "@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"
-            }
+            },
+            "minItems": 2,
+            "description": "JSON-LD Context."
         },
-        "type": {
+        "id": {
             "type": "string",
+            "description": "The id of the element."
+        },
+        "type": {
             "const": "AuditableItemGraphVertex",
             "description": "JSON-LD Type."
         },
         "organizationIdentity": {
             "type": "string",
-            "description": "The identity of the organization which controls the vertex. json-ld namespace:twin-common"
+            "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. json-ld namespace:twin-common"
+            "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. json-ld container:set"
+            "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. json-ld container:set"
+            "description": "The resources attached to the vertex."
         },
         "edges": {
             "type": "array",
             "items": {
                 "$ref": "https://schema.twindev.org/aig/AuditableItemGraphEdge"
             },
-            "description": "Edges connected to the vertex. json-ld container:set"
+            "description": "Edges connected to the vertex."
         },
         "verified": {
             "type": "boolean",
-            "description": "Is the vertex verified, will only be populated when verification is requested. json-ld namespace:twin-common"
+            "description": "Is the vertex verified, will only be populated when verification is requested."
         }
     },
     "required": [
         "@context",
         "id",
         "type"
+    ],
+    "allOf": [
+        {
+            "description": "Interface describing the base properties for auditable elements.",
+            "type": "object",
+            "properties": {
+                "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."
+                }
+            },
+            "$comment": "Inlined utility base type AuditableItemGraphAuditedElement so utility transformations can operate on concrete properties instead of a $ref."
+        }
     ]
 }

package/dist/es/schemas/AuditableItemGraphVertexList.json

@@ -1,41 +1,39 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "https://schema.twindev.org/aig/AuditableItemGraphVertexList",
+    "title": "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"
-            }
+            },
+            "minItems": 2,
+            "description": "JSON-LD Context."
         },
         "type": {
             "type": "array",
-            "items": {
-                "allOf": [
-                    {
-                        "type": "string",
-                        "const": "ItemList"
-                    },
-                    {
-                        "type": "string",
-                        "const": "AuditableItemGraphVertexList"
-                    }
-                ]
-            },
+            "prefixItems": [
+                {
+                    "const": "ItemList"
+                },
+                {
+                    "const": "AuditableItemGraphVertexList"
+                }
+            ],
+            "items": false,
+            "minItems": 2,
+            "maxItems": 2,
             "description": "JSON-LD Type."
         },
         "itemListElement": {
@@ -43,7 +41,7 @@
             "items": {
                 "$ref": "https://schema.twindev.org/aig/AuditableItemGraphVertex"
             },
-            "description": "The list of vertices. json-ld namespace:sch"
+            "description": "The list of vertices."
         }
     },
     "required": [

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

@@ -9,7 +9,7 @@ export interface IAuditableItemGraphAlias extends IAuditableItemGraphAuditedElem
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphContexts.Context | [typeof AuditableItemGraphContexts.Context, ...IJsonLdContextDefinitionElement[]];
+    "@context"?: typeof AuditableItemGraphContexts.Context | [typeof AuditableItemGraphContexts.Context, ...IJsonLdContextDefinitionElement[]];
     /**
      * The id of the element.
      */
@@ -20,12 +20,17 @@ export interface IAuditableItemGraphAlias extends IAuditableItemGraphAuditedElem
     type: typeof AuditableItemGraphTypes.Alias;
     /**
      * The JSON-LD annotation object for the alias.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     annotationObject?: IJsonLdNodeObject;
     /**
      * The format of the id in the alias.
-     * json-ld type:sch:Text
+     * @json-ld type:sch:Text
      */
     aliasFormat?: string;
+    /**
+     * Whether the alias should be unique across the graph, meaning that no other vertex can have the same alias. Defaults to false.
+     * @json-ld type:sch:Boolean
+     */
+    unique?: boolean;
 }

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

@@ -8,17 +8,17 @@ export interface IAuditableItemGraphAuditedElement {
     id?: string;
     /**
      * The date/time of when the element was created.
-     * json-ld namespace:sch
+     * @json-ld namespace:sch
      */
     dateCreated?: string;
     /**
      * The date/time of when the element was modified.
-     * json-ld namespace:sch
+     * @json-ld namespace:sch
      */
     dateModified?: string;
     /**
      * The date/time of when the element was deleted, as we never actually remove items.
-     * json-ld namespace:sch
+     * @json-ld namespace:sch
      */
     dateDeleted?: string;
 }

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

@@ -25,27 +25,27 @@ export interface IAuditableItemGraphChangeset {
     id: string;
     /**
      * The date/time of when the changeset was created.
-     * json-ld namespace:sch
+     * @json-ld namespace:sch
      */
     dateCreated: string;
     /**
      * The user identity that created the changes.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     userIdentity?: string;
     /**
      * The patches in the changeset.
-     * json-ld container:set
+     * @json-ld container:set
      */
     patches: IAuditableItemGraphPatchOperation[];
     /**
      * The immutable proof id which contains the signature for this changeset.
-     * json-ld type:sch:identifier
+     * @json-ld type:sch:identifier
      */
     proofId?: string;
     /**
      * The verification for the changeset.
-     * json-ld id
+     * @json-ld id
      */
     verification?: IImmutableProofVerification;
 }

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

@@ -21,7 +21,7 @@ export interface IAuditableItemGraphChangesetList {
     type: [typeof SchemaOrgTypes.ItemList, typeof AuditableItemGraphTypes.ChangesetList];
     /**
      * The list of changesets.
-     * json-ld namespace:sch
+     * @json-ld namespace:sch
      */
     [SchemaOrgTypes.ItemListElement]: IAuditableItemGraphChangeset[];
 }

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

@@ -1,5 +1,4 @@
 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 { IAuditableItemGraphChangeset } from "./IAuditableItemGraphChangeset.js";
 import type { IAuditableItemGraphChangesetList } from "./IAuditableItemGraphChangesetList.js";
@@ -19,24 +18,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
      * @param vertex.edges The edges connected to the vertex.
      * @returns The id of the new graph item.
      */
-    create(vertex: {
-        annotationObject?: IJsonLdNodeObject;
-        aliases?: {
-            id: string;
-            aliasFormat?: string;
-            unique?: boolean;
-            annotationObject?: IJsonLdNodeObject;
-        }[];
-        resources?: {
-            id?: string;
-            resourceObject?: IJsonLdNodeObject;
-        }[];
-        edges?: {
-            targetId: string;
-            edgeRelationships: string[];
-            annotationObject?: IJsonLdNodeObject;
-        }[];
-    }): Promise<string>;
+    create(vertex: Omit<IAuditableItemGraphVertex, "id">): Promise<string>;
     /**
      * Update a graph vertex.
      * @param vertex The vertex to update.
@@ -47,26 +29,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
      * @param vertex.edges The edges connected to the vertex.
      * @returns Nothing.
      */
-    update(vertex: {
-        id: string;
-        annotationObject?: IJsonLdNodeObject;
-        aliases?: {
-            id: string;
-            aliasFormat?: string;
-            unique?: boolean;
-            annotationObject?: IJsonLdNodeObject;
-        }[];
-        resources?: {
-            id?: string;
-            resourceObject?: IJsonLdNodeObject;
-        }[];
-        edges?: {
-            id?: string;
-            targetId: string;
-            edgeRelationships: string[];
-            annotationObject?: IJsonLdNodeObject;
-        }[];
-    }): Promise<void>;
+    update(vertex: IAuditableItemGraphVertex): Promise<void>;
     /**
      * Get a graph vertex.
      * @param id The id of the vertex to get.

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

@@ -9,14 +9,14 @@ export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedEleme
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphContexts.Context | [typeof AuditableItemGraphContexts.Context, ...IJsonLdContextDefinitionElement[]];
+    "@context"?: typeof AuditableItemGraphContexts.Context | [typeof AuditableItemGraphContexts.Context, ...IJsonLdContextDefinitionElement[]];
     /**
      * The id of the element.
      */
     id?: string;
     /**
      * The target vertex id the edge connects to.
-     * json-ld type:@id
+     * @json-ld type:@id
      */
     targetId: string;
     /**
@@ -25,12 +25,12 @@ export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedEleme
     type: typeof AuditableItemGraphTypes.Edge;
     /**
      * The JSON-LD annotation object for the edge.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     annotationObject?: IJsonLdNodeObject;
     /**
      * The relationships between the two vertices.
-     * json-ld container:set
+     * @json-ld container:set
      */
     edgeRelationships: string[];
 }

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

@@ -15,22 +15,22 @@ export interface IAuditableItemGraphPatchOperation {
     type: typeof AuditableItemGraphTypes.PatchOperation;
     /**
      * The operation that was performed on the item.
-     * json-ld type:sch:Text
+     * @json-ld type:sch:Text
      */
     patchOperation: "add" | "remove" | "replace" | "move" | "copy" | "test";
     /**
      * The path to the object that was changed.
-     * json-ld type:sch:Text
+     * @json-ld type:sch:Text
      */
     patchPath: string;
     /**
      * The path the value was copied or moved from.
-     * json-ld type:sch:Text
+     * @json-ld type:sch:Text
      */
     patchFrom?: string;
     /**
      * The value to add.
-     * json-ld type:json
+     * @json-ld type:json
      */
     patchValue?: unknown;
 }

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

@@ -9,14 +9,14 @@ export interface IAuditableItemGraphResource extends IAuditableItemGraphAuditedE
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphContexts.Context | [typeof AuditableItemGraphContexts.Context, ...IJsonLdContextDefinitionElement[]];
+    "@context"?: typeof AuditableItemGraphContexts.Context | [typeof AuditableItemGraphContexts.Context, ...IJsonLdContextDefinitionElement[]];
     /**
      * JSON-LD Type.
      */
     type: typeof AuditableItemGraphTypes.Resource;
     /**
      * The JSON-LD object for the resource.
-     * json-ld type:json
+     * @json-ld type:json
      */
     resourceObject?: IJsonLdNodeObject;
 }

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

@@ -27,32 +27,32 @@ export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAudit
     type: typeof AuditableItemGraphTypes.Vertex;
     /**
      * The identity of the organization which controls the vertex.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     organizationIdentity?: string;
     /**
      * The JSON-LD annotation object for the vertex.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     annotationObject?: IJsonLdNodeObject;
     /**
      * Alternative aliases that can be used to identify the vertex.
-     * json-ld container:set
+     * @json-ld container:set
      */
     aliases?: IAuditableItemGraphAlias[];
     /**
      * The resources attached to the vertex.
-     * json-ld container:set
+     * @json-ld container:set
      */
     resources?: IAuditableItemGraphResource[];
     /**
      * Edges connected to the vertex.
-     * json-ld container:set
+     * @json-ld container:set
      */
     edges?: IAuditableItemGraphEdge[];
     /**
      * Is the vertex verified, will only be populated when verification is requested.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     verified?: boolean;
 }

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

@@ -21,7 +21,7 @@ export interface IAuditableItemGraphVertexList {
     type: [typeof SchemaOrgTypes.ItemList, typeof AuditableItemGraphTypes.VertexList];
     /**
      * The list of vertices.
-     * json-ld namespace:sch
+     * @json-ld namespace:sch
      */
     [SchemaOrgTypes.ItemListElement]: IAuditableItemGraphVertex[];
 }

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

@@ -1,4 +1,4 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex.js";
 /**
  * Create an auditable item graph vertex.
  */
@@ -6,34 +6,5 @@ export interface IAuditableItemGraphCreateRequest {
     /**
      * The data to be used in the vertex.
      */
-    body: {
-        /**
-         * The object to be used in the vertex as JSON-LD.
-         */
-        annotationObject?: IJsonLdNodeObject;
-        /**
-         * Alternative aliases that can be used to identify the vertex.
-         */
-        aliases?: {
-            id: string;
-            aliasFormat?: string;
-            unique?: boolean;
-            annotationObject?: IJsonLdNodeObject;
-        }[];
-        /**
-         * The resources attached to the vertex.
-         */
-        resources?: {
-            id?: string;
-            resourceObject?: IJsonLdNodeObject;
-        }[];
-        /**
-         * The edges connected to the vertex.
-         */
-        edges?: {
-            targetId: string;
-            edgeRelationships: string[];
-            annotationObject?: IJsonLdNodeObject;
-        }[];
-    };
+    body: Omit<IAuditableItemGraphVertex, "id">;
 }