@twin.org/auditable-item-graph-models 0.0.1-next.3 → 0.0.1-next.30

package/dist/types/index.d.ts

@@ -5,16 +5,18 @@ 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/auditableItemGraphVerificationState";
+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/IAuditableItemGraphCredential";
 export * from "./models/IAuditableItemGraphEdge";
 export * from "./models/IAuditableItemGraphPatchOperation";
 export * from "./models/IAuditableItemGraphResource";
-export * from "./models/IAuditableItemGraphVerification";
 export * from "./models/IAuditableItemGraphVertex";
+export * from "./models/IAuditableItemGraphVertexList";
 export * from "./models/verifyDepth";

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

@@ -1,11 +1,29 @@
+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 { IAuditableItemGraphMetadataElement } from "./IAuditableItemGraphMetadataElement";
 /**
  * Interface describing an alias for a vertex.
  */
-export interface IAuditableItemGraphAlias extends IAuditableItemGraphAuditedElement, IAuditableItemGraphMetadataElement {
+export interface IAuditableItemGraphAlias extends IAuditableItemGraphAuditedElement {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": typeof AuditableItemGraphContexts.ContextRoot | [typeof AuditableItemGraphContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]];
+    /**
+     * The id of the element.
+     */
+    id: string;
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AuditableItemGraphTypes.Alias;
+    /**
+     * The JSON-LD annotation object for the alias.
+     */
+    annotationObject?: IJsonLdNodeObject;
     /**
      * The format of the id in the alias.
      */
-    format?: string;
+    aliasFormat?: string;
 }

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

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

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

@@ -1,12 +1,32 @@
+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";
 /**
  * Interface describing a set of updates to the vertex.
  */
 export interface IAuditableItemGraphChangeset {
     /**
-     * The timestamp of when the changeset was created.
+     * JSON-LD Context.
      */
-    created: number;
+    "@context": [
+        typeof AuditableItemGraphContexts.ContextRoot,
+        typeof AuditableItemGraphContexts.ContextRootCommon,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AuditableItemGraphTypes.Changeset;
+    /**
+     * The id of the changeset.
+     */
+    id: string;
+    /**
+     * The date/time of when the changeset was created.
+     */
+    dateCreated: string;
     /**
      * The user identity that created the changes.
      */
@@ -16,15 +36,11 @@ export interface IAuditableItemGraphChangeset {
      */
     patches: IAuditableItemGraphPatchOperation[];
     /**
-     * The hash for the changeset.
-     */
-    hash: string;
-    /**
-     * The signature for the changeset.
+     * The immutable proof id which contains the signature for this changeset.
      */
-    signature: string;
+    proofId?: string;
     /**
-     * The immutable storage id containing the signature for the changeset.
+     * The verification for the changeset.
      */
-    immutableStorageId?: string;
+    verification?: IImmutableProofVerification;
 }

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

@@ -1,62 +1,71 @@
 import type { IComponent } from "@twin.org/core";
-import type { IJsonLdDocument, IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { SortDirection } from "@twin.org/entity";
-import type { IAuditableItemGraphVerification } from "./IAuditableItemGraphVerification";
+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";
-/**
- * The return type based on the response type.
- */
-export type JsonReturnType<T, U, V> = T extends "json" ? U : V;
 /**
  * Interface describing an auditable item graph contract.
  */
 export interface IAuditableItemGraphComponent extends IComponent {
     /**
      * Create a new graph vertex.
-     * @param metadata The metadata for the vertex as JSON-LD.
-     * @param aliases Alternative aliases that can be used to identify the vertex.
-     * @param resources The resources attached to the vertex.
-     * @param edges The edges connected to the vertex.
+     * @param vertex The vertex to create.
+     * @param vertex.annotationObject The annotation object for the vertex as JSON-LD.
+     * @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(metadata?: IJsonLdNodeObject, aliases?: {
-        id: string;
-        format?: string;
-        metadata?: IJsonLdNodeObject;
-    }[], resources?: {
-        id: string;
-        metadata?: IJsonLdNodeObject;
-    }[], edges?: {
-        id: string;
-        relationship: string;
-        metadata?: IJsonLdNodeObject;
-    }[], userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    create(vertex: {
+        annotationObject?: IJsonLdNodeObject;
+        aliases?: {
+            id: string;
+            aliasFormat?: string;
+            annotationObject?: IJsonLdNodeObject;
+        }[];
+        resources?: {
+            id?: string;
+            resourceObject?: IJsonLdNodeObject;
+        }[];
+        edges?: {
+            id: string;
+            edgeRelationship: string;
+            annotationObject?: IJsonLdNodeObject;
+        }[];
+    }, userIdentity?: string, nodeIdentity?: string): Promise<string>;
     /**
      * Update a graph vertex.
-     * @param id The id of the vertex to update.
-     * @param metadata The metadata for the vertex as JSON-LD.
-     * @param aliases Alternative aliases that can be used to identify the vertex.
-     * @param resources The resources attached to the vertex.
-     * @param edges The edges connected to the vertex.
+     * @param vertex The vertex to update.
+     * @param vertex.id The id of the vertex to update.
+     * @param vertex.annotationObject The annotation object for the vertex as JSON-LD.
+     * @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(id: string, metadata?: IJsonLdNodeObject, aliases?: {
-        id: string;
-        format?: string;
-        metadata?: IJsonLdNodeObject;
-    }[], resources?: {
-        id: string;
-        metadata?: IJsonLdNodeObject;
-    }[], edges?: {
+    update(vertex: {
         id: string;
-        relationship: string;
-        metadata?: IJsonLdNodeObject;
-    }[], userIdentity?: string, nodeIdentity?: string): Promise<void>;
+        annotationObject?: IJsonLdNodeObject;
+        aliases?: {
+            id: string;
+            aliasFormat?: string;
+            annotationObject?: IJsonLdNodeObject;
+        }[];
+        resources?: {
+            id?: string;
+            resourceObject?: IJsonLdNodeObject;
+        }[];
+        edges?: {
+            id: string;
+            edgeRelationship: string;
+            annotationObject?: IJsonLdNodeObject;
+        }[];
+    }, userIdentity?: string, nodeIdentity?: string): Promise<void>;
     /**
      * Get a graph vertex.
      * @param id The id of the vertex to get.
@@ -64,18 +73,14 @@ export interface IAuditableItemGraphComponent extends IComponent {
      * @param options.includeDeleted Whether to include deleted aliases, resource, edges, defaults to false.
      * @param options.includeChangesets Whether to include the changesets of the vertex, defaults to false.
      * @param options.verifySignatureDepth How many signatures to verify, defaults to "none".
-     * @param responseType The response type to return, defaults to application/json.
      * @returns The vertex if found.
      * @throws NotFoundError if the vertex is not found.
      */
-    get<T extends "json" | "jsonld" = "json">(id: string, options?: {
+    get(id: string, options?: {
         includeDeleted?: boolean;
         includeChangesets?: boolean;
         verifySignatureDepth?: VerifyDepth;
-    }, responseType?: T): Promise<JsonReturnType<T, IAuditableItemGraphVertex & {
-        verified?: boolean;
-        changesetsVerification?: IAuditableItemGraphVerification[];
-    }, IJsonLdDocument>>;
+    }): Promise<IAuditableItemGraphVertex>;
     /**
      * Remove the immutable storage for an item.
      * @param id The id of the vertex to remove the storage from.
@@ -89,25 +94,16 @@ export interface IAuditableItemGraphComponent extends IComponent {
      * @param options The query options.
      * @param options.id The optional id to look for.
      * @param options.idMode Look in id, alias or both, defaults to both.
-     * @param orderBy The order for the results, defaults to created.
+     * @param conditions Conditions to use in the query.
+     * @param orderBy The order for the results, defaults to dateCreated.
      * @param orderByDirection The direction for the order, defaults to descending.
-     * @param properties The properties to return, if not provided defaults to id, created, aliases and metadata.
+     * @param properties The properties to return, if not provided defaults to id, dateCreated, aliases and object.
      * @param cursor The cursor to request the next page of entities.
      * @param pageSize The maximum number of entities in a page.
-     * @param responseType The response type to return, defaults to application/json.
      * @returns The entities, which can be partial if a limited keys list was provided.
      */
-    query<T extends "json" | "jsonld" = "json">(options?: {
+    query(options?: {
         id?: string;
         idMode?: "id" | "alias" | "both";
-    }, orderBy?: "created" | "updated", orderByDirection?: SortDirection, properties?: (keyof IAuditableItemGraphVertex)[], cursor?: string, pageSize?: number, responseType?: T): Promise<JsonReturnType<T, {
-        /**
-         * The entities, which can be partial if a limited keys list was provided.
-         */
-        entities: Partial<IAuditableItemGraphVertex>[];
-        /**
-         * An optional cursor, when defined can be used to call find to get more entities.
-         */
-        cursor?: string;
-    }, IJsonLdDocument>>;
+    }, conditions?: IComparator[], orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemGraphVertex)[], cursor?: string, pageSize?: number): Promise<IAuditableItemGraphVertexList>;
 }

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

@@ -1,11 +1,29 @@
+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 { IAuditableItemGraphMetadataElement } from "./IAuditableItemGraphMetadataElement";
 /**
  * Interface describing an edge between two vertices in an auditable item graph.
  */
-export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedElement, IAuditableItemGraphMetadataElement {
+export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedElement {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": typeof AuditableItemGraphContexts.ContextRoot | [typeof AuditableItemGraphContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]];
+    /**
+     * The id of the element.
+     */
+    id: string;
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AuditableItemGraphTypes.Edge;
+    /**
+     * The JSON-LD annotation object for the edge.
+     */
+    annotationObject?: IJsonLdNodeObject;
     /**
      * The relationship between the two vertices.
      */
-    relationship: string;
+    edgeRelationship: string;
 }

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

@@ -1,6 +1,32 @@
-import type { IPatchOperation } from "@twin.org/core";
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 /**
  * The patch operation for JSON diffs.
  */
-export interface IAuditableItemGraphPatchOperation extends IPatchOperation {
+export interface IAuditableItemGraphPatchOperation {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": typeof AuditableItemGraphContexts.ContextRoot | [typeof AuditableItemGraphContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]];
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AuditableItemGraphTypes.PatchOperation;
+    /**
+     * The operation that was performed on the item.
+     */
+    patchOperation: "add" | "remove" | "replace" | "move" | "copy" | "test";
+    /**
+     * The path to the object that was changed.
+     */
+    patchPath: string;
+    /**
+     * The path the value was copied or moved from.
+     */
+    patchFrom?: string;
+    /**
+     * The value to add.
+     */
+    patchValue?: unknown;
 }

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

@@ -1,7 +1,21 @@
+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 { IAuditableItemGraphMetadataElement } from "./IAuditableItemGraphMetadataElement";
 /**
  * Interface describing an auditable item graph vertex resource.
  */
-export interface IAuditableItemGraphResource extends IAuditableItemGraphAuditedElement, IAuditableItemGraphMetadataElement {
+export interface IAuditableItemGraphResource extends IAuditableItemGraphAuditedElement {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": typeof AuditableItemGraphContexts.ContextRoot | [typeof AuditableItemGraphContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]];
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AuditableItemGraphTypes.Resource;
+    /**
+     * The JSON-LD object for the resource.
+     */
+    resourceObject?: IJsonLdNodeObject;
 }

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

@@ -1,17 +1,39 @@
+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 { IAuditableItemGraphMetadataElement } from "./IAuditableItemGraphMetadataElement";
 import type { IAuditableItemGraphResource } from "./IAuditableItemGraphResource";
 /**
  * Interface describing an auditable item graph vertex.
  */
-export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAuditedElement, "deleted">, IAuditableItemGraphMetadataElement {
+export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAuditedElement, "deleted"> {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": [
+        typeof AuditableItemGraphContexts.ContextRoot,
+        typeof AuditableItemGraphContexts.ContextRootCommon,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * The id of the element.
+     */
+    id: string;
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AuditableItemGraphTypes.Vertex;
     /**
      * The identity of the node which controls the vertex.
      */
     nodeIdentity?: string;
+    /**
+     * The JSON-LD annotation object for the vertex.
+     */
+    annotationObject?: IJsonLdNodeObject;
     /**
      * Alternative aliases that can be used to identify the vertex.
      */
@@ -28,4 +50,8 @@ export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAudit
      * Changesets for the vertex.
      */
     changesets?: IAuditableItemGraphChangeset[];
+    /**
+     * Is the vertex verified, will only be populated when verification is requested.
+     */
+    verified?: boolean;
 }

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

@@ -0,0 +1,25 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
+import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex";
+/**
+ * Interface describing an auditable item graph vertex list.
+ */
+export interface IAuditableItemGraphVertexList {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": typeof AuditableItemGraphContexts.ContextRoot | [typeof AuditableItemGraphContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]];
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AuditableItemGraphTypes.VertexList;
+    /**
+     * The list of vertices.
+     */
+    vertices: IAuditableItemGraphVertex[];
+    /**
+     * The cursor to get the next chunk of vertices.
+     */
+    cursor?: string;
+}

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

@@ -6,33 +6,33 @@ export interface IAuditableItemGraphCreateRequest {
     /**
      * The data to be used in the vertex.
      */
-    body?: {
+    body: {
         /**
-         * The metadata to be used in the vertex as JSON-LD.
+         * The object to be used in the vertex as JSON-LD.
          */
-        metadata?: IJsonLdNodeObject;
+        annotationObject?: IJsonLdNodeObject;
         /**
          * Alternative aliases that can be used to identify the vertex.
          */
         aliases?: {
             id: string;
-            format?: string;
-            metadata?: IJsonLdNodeObject;
+            aliasFormat?: string;
+            annotationObject?: IJsonLdNodeObject;
         }[];
         /**
          * The resources attached to the vertex.
          */
         resources?: {
-            id: string;
-            metadata?: IJsonLdNodeObject;
+            id?: string;
+            resourceObject?: IJsonLdNodeObject;
         }[];
         /**
          * The edges connected to the vertex.
          */
         edges?: {
             id: string;
-            relationship: string;
-            metadata?: IJsonLdNodeObject;
+            edgeRelationship: string;
+            annotationObject?: IJsonLdNodeObject;
         }[];
     };
 }

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

@@ -1,4 +1,4 @@
-import type { MimeTypes } from "@twin.org/web";
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
 import type { VerifyDepth } from "../verifyDepth";
 /**
  * Get an auditable item graph vertex.
@@ -8,7 +8,7 @@ export interface IAuditableItemGraphGetRequest {
      * The headers which can be used to determine the response data type.
      */
     headers?: {
-        Accept: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
     };
     /**
      * The parameters from the path.

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

@@ -1,6 +1,4 @@
-import type { IJsonLdDocument } from "@twin.org/data-json-ld";
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IAuditableItemGraphVerification } from "../IAuditableItemGraphVerification";
 import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex";
 /**
  * Response to getting an auditable item graph vertex.
@@ -13,16 +11,7 @@ export interface IAuditableItemGraphGetResponse {
         [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
     };
     /**
-     * The response body, if accept header is set to application/ld+json the return object is JSON-LD document.
+     * The response body.
      */
-    body: IJsonLdDocument | (IAuditableItemGraphVertex & {
-        /**
-         * Whether the vertex and its elements have been verified.
-         */
-        verified?: boolean;
-        /**
-         * The verification for the changesets including any failure information.
-         */
-        changesetsVerification?: IAuditableItemGraphVerification[];
-    });
+    body: IAuditableItemGraphVertex;
 }

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

@@ -1,5 +1,6 @@
 import type { SortDirection } from "@twin.org/entity";
-import type { MimeTypes } from "@twin.org/web";
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex";
 /**
  * Get the a list of the vertices with matching ids or aliases.
  */
@@ -8,7 +9,7 @@ export interface IAuditableItemGraphListRequest {
      * The headers which can be used to determine the response data type.
      */
     headers?: {
-        Accept: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
     };
     /**
      * The query parameters.
@@ -23,15 +24,19 @@ export interface IAuditableItemGraphListRequest {
          */
         idMode?: "id" | "alias" | "both";
         /**
-         * The order for the results, default to created.
+         * The conditions to filter the streams, JSON stringified IComparator[].
          */
-        orderBy?: "created" | "updated";
+        conditions?: string;
+        /**
+         * The order for the results, default to dateCreated.
+         */
+        orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">;
         /**
          * The direction for the order, defaults to desc.
          */
         orderByDirection?: SortDirection;
         /**
-         * The properties to return as a comma separated list, defaults to "id,created,aliases,metadata".
+         * The properties to return as a comma separated list, defaults to "id,dateCreated,aliases,annotationObject".
          */
         properties?: string;
         /**

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

@@ -1,6 +1,5 @@
-import type { IJsonLdDocument } from "@twin.org/data-json-ld";
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex";
+import type { IAuditableItemGraphVertexList } from "../IAuditableItemGraphVertexList";
 /**
  * The response to getting the a list of the vertices with matching ids or aliases.
  */
@@ -14,14 +13,5 @@ export interface IAuditableItemGraphListResponse {
     /**
      * The response payload.
      */
-    body: IJsonLdDocument | {
-        /**
-         * The entities, which can be partial if a limited keys list was provided.
-         */
-        entities?: Partial<IAuditableItemGraphVertex>[];
-        /**
-         * An optional cursor, when defined can be used to call find to get more entities.
-         */
-        cursor?: string;
-    };
+    body: IAuditableItemGraphVertexList;
 }