@twin.org/auditable-item-graph-models 0.0.3-next.9 → 0.9.0-next.1

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

@@ -27,32 +27,38 @@ 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;
+    /**
+     * The version of the vertex, populated only when getting a specific version.
+     * Maps to https://schema.org/version.
+     * @json-ld namespace:sch
+     */
+    version?: number;
 }

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:schema
+     * @json-ld namespace:sch
      */
     [SchemaOrgTypes.ItemListElement]: IAuditableItemGraphVertex[];
 }

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

@@ -0,0 +1,29 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+/**
+ * Interface describing a list of auditable item graph vertex version numbers.
+ */
+export interface IAuditableItemGraphVertexVersionList {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": [
+        typeof SchemaOrgContexts.Context,
+        typeof AuditableItemGraphContexts.Context,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * JSON-LD Type.
+     */
+    type: [typeof SchemaOrgTypes.ItemList, typeof AuditableItemGraphTypes.VertexVersionList];
+    /**
+     * The list of versions.
+     * @json-ld namespace:sch
+     */
+    [SchemaOrgTypes.ItemListElement]: {
+        version: number;
+        dateCreated: string;
+    }[];
+}

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">;
 }

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

@@ -0,0 +1,14 @@
+/**
+ * Remove the notarization proof from all changesets of a graph vertex.
+ */
+export interface IAuditableItemGraphRemoveProofRequest {
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex whose proof should be removed.
+         */
+        id: string;
+    };
+}

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

@@ -0,0 +1,20 @@
+import type { IAuditableItemGraphPartialVertex } from "../IAuditableItemGraphPartialVertex.js";
+/**
+ * Partially update an auditable item graph vertex (PATCH — explicit list patches).
+ */
+export interface IAuditableItemGraphUpdatePartialRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex to update.
+         */
+        id: string;
+    };
+    /**
+     * Partial vertex data; only defined properties are applied.
+     * Sub-lists use `{ add, remove }` patch objects.
+     */
+    body: Omit<IAuditableItemGraphPartialVertex, "id">;
+}

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

@@ -1,6 +1,6 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex.js";
 /**
- * Update an auditable item graph vertex.
+ * Update an auditable item graph vertex (PUT — full replacement of vertex state).
  */
 export interface IAuditableItemGraphUpdateRequest {
     /**
@@ -13,37 +13,7 @@ export interface IAuditableItemGraphUpdateRequest {
         id: string;
     };
     /**
-     * The data to be used in the vertex.
+     * The full vertex payload. Replaces annotation and active sub-lists; omitted collections are cleared.
      */
-    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?: {
-            id?: string;
-            targetId: string;
-            edgeRelationships: string[];
-            annotationObject?: IJsonLdNodeObject;
-        }[];
-    };
+    body: Omit<IAuditableItemGraphVertex, "id">;
 }

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

@@ -0,0 +1,25 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+/**
+ * Get an auditable item graph vertex at a specific version.
+ */
+export interface IAuditableItemGraphVersionGetRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex.
+         */
+        id: string;
+        /**
+         * The version number to get.
+         */
+        version: string;
+    };
+}

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

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex.js";
+/**
+ * Response to getting an auditable item graph vertex at a specific version.
+ */
+export interface IAuditableItemGraphVersionGetResponse {
+    /**
+     * The headers.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The response body.
+     */
+    body: IAuditableItemGraphVertex;
+}

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

@@ -0,0 +1,34 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+/**
+ * Get all versions of an auditable item graph vertex.
+ */
+export interface IAuditableItemGraphVersionListRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex.
+         */
+        id: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * Only return versions created after this ISO 8601 timestamp (exclusive).
+         */
+        after?: string;
+        /**
+         * Only return versions created before this ISO 8601 timestamp (exclusive).
+         */
+        before?: string;
+    };
+}

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

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IAuditableItemGraphVertexVersionList } from "../IAuditableItemGraphVertexVersionList.js";
+/**
+ * Response to getting all versions of an auditable item graph vertex.
+ */
+export interface IAuditableItemGraphVersionListResponse {
+    /**
+     * The headers.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The response body.
+     */
+    body: IAuditableItemGraphVertexVersionList;
+}

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

@@ -0,0 +1,69 @@
+/**
+ * Metric IDs for the auditable item graph service.
+ */
+export declare const AuditableItemGraphMetricIds: {
+    /**
+     * Number of vertices created.
+     */
+    readonly VerticesCreated: "aig_vertices_created";
+    /**
+     * Number of vertices updated.
+     */
+    readonly VerticesUpdated: "aig_vertices_updated";
+    /**
+     * Number of changesets created.
+     */
+    readonly ChangesetsCreated: "aig_changesets_created";
+    /**
+     * Number of aliases added.
+     */
+    readonly AliasesAdded: "aig_aliases_added";
+    /**
+     * Number of aliases modified.
+     */
+    readonly AliasesModified: "aig_aliases_modified";
+    /**
+     * Number of aliases deleted.
+     */
+    readonly AliasesDeleted: "aig_aliases_deleted";
+    /**
+     * Number of resources added.
+     */
+    readonly ResourcesAdded: "aig_resources_added";
+    /**
+     * Number of resources modified.
+     */
+    readonly ResourcesModified: "aig_resources_modified";
+    /**
+     * Number of resources deleted.
+     */
+    readonly ResourcesDeleted: "aig_resources_deleted";
+    /**
+     * Number of edges added.
+     */
+    readonly EdgesAdded: "aig_edges_added";
+    /**
+     * Number of edges modified.
+     */
+    readonly EdgesModified: "aig_edges_modified";
+    /**
+     * Number of edges deleted.
+     */
+    readonly EdgesDeleted: "aig_edges_deleted";
+    /**
+     * Number of queries executed.
+     */
+    readonly QueriesExecuted: "aig_queries_executed";
+    /**
+     * Number of verifications succeeded.
+     */
+    readonly VerificationsSucceeded: "aig_verifications_succeeded";
+    /**
+     * Number of verifications failed.
+     */
+    readonly VerificationsFailed: "aig_verifications_failed";
+};
+/**
+ * Metric IDs for the auditable item graph service.
+ */
+export type AuditableItemGraphMetricIds = (typeof AuditableItemGraphMetricIds)[keyof typeof AuditableItemGraphMetricIds];

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

@@ -0,0 +1,5 @@
+import { type ITelemetryMetric } from "@twin.org/telemetry-models";
+/**
+ * Metrics registered by the auditable item graph service.
+ */
+export declare const AuditableItemGraphMetrics: ITelemetryMetric[];

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

@@ -34,6 +34,18 @@ export declare const AuditableItemGraphTypes: {
      * Represents patch operation.
      */
     readonly PatchOperation: "AuditableItemGraphPatchOperation";
+    /**
+     * Represents auditable item graph vertex version list.
+     */
+    readonly VertexVersionList: "AuditableItemGraphVertexVersionList";
+    /**
+     * Represents auditable item graph partial vertex.
+     */
+    readonly PartialVertex: "AuditableItemGraphPartialVertex";
+    /**
+     * Represents auditable item graph list patch.
+     */
+    readonly ListPatch: "AuditableItemGraphListPatch";
 };
 /**
  * The types of auditable item graph data.