@twin.org/auditable-item-graph-models 0.0.3-next.2 → 0.0.3-next.20

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

@@ -9,13 +9,14 @@ export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedEleme
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphContexts.Namespace | [typeof AuditableItemGraphContexts.Namespace, ...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
      */
     targetId: string;
     /**
@@ -24,10 +25,12 @@ export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedEleme
     type: typeof AuditableItemGraphTypes.Edge;
     /**
      * The JSON-LD annotation object for the edge.
+     * @json-ld namespace:twin-common
      */
     annotationObject?: IJsonLdNodeObject;
     /**
      * The relationships between the two vertices.
+     * @json-ld container:set
      */
     edgeRelationships: string[];
 }

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

@@ -0,0 +1,18 @@
+import type { IAuditableItemGraphAlias } from "./IAuditableItemGraphAlias.js";
+import type { IAuditableItemGraphEdge } from "./IAuditableItemGraphEdge.js";
+import type { IAuditableItemGraphResource } from "./IAuditableItemGraphResource.js";
+/**
+ * PATCH operations for a sub-list on a vertex.
+ */
+export interface IAuditableItemGraphListPatch<TItem = IAuditableItemGraphEdge | IAuditableItemGraphAlias | IAuditableItemGraphResource> {
+    /**
+     * Items to add or update in the active set.
+     * @json-ld container:set
+     */
+    add?: TItem[];
+    /**
+     * Identifiers of items to remove from the active set (soft-delete).
+     * @json-ld container:set
+     */
+    remove?: string[];
+}

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

@@ -0,0 +1,45 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphAlias } from "./IAuditableItemGraphAlias.js";
+import type { IAuditableItemGraphEdge } from "./IAuditableItemGraphEdge.js";
+import type { IAuditableItemGraphListPatch } from "./IAuditableItemGraphListPatch.js";
+import type { IAuditableItemGraphResource } from "./IAuditableItemGraphResource.js";
+import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex.js";
+/**
+ * Partial vertex payload for updatePartial (PATCH — requires id).
+ * Sub-lists use explicit `{ add, remove }` patches; bare arrays are not supported.
+ */
+export interface IAuditableItemGraphPartialVertex extends Omit<IAuditableItemGraphVertex, "type" | "aliases" | "edges" | "resources"> {
+    /**
+     * The id of the vertex to update.
+     */
+    id: string;
+    /**
+     * JSON-LD Context.
+     */
+    "@context": [
+        typeof AuditableItemGraphContexts.Context,
+        typeof AuditableItemGraphContexts.ContextCommon,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * JSON-LD Type.
+     */
+    type?: typeof AuditableItemGraphTypes.Vertex;
+    /**
+     * Patch operations for aliases.
+     * @json-ld id
+     */
+    aliasPatches?: IAuditableItemGraphListPatch<IAuditableItemGraphAlias>;
+    /**
+     * Patch operations for resources.
+     * @json-ld id
+     */
+    resourcePatches?: IAuditableItemGraphListPatch<IAuditableItemGraphResource>;
+    /**
+     * Patch operations for edges.
+     * @json-ld id
+     */
+    edgePatches?: IAuditableItemGraphListPatch<IAuditableItemGraphEdge>;
+}

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

@@ -8,25 +8,29 @@ export interface IAuditableItemGraphPatchOperation {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphContexts.Namespace | [typeof AuditableItemGraphContexts.Namespace, ...IJsonLdContextDefinitionElement[]];
+    "@context"?: typeof AuditableItemGraphContexts.Context | [typeof AuditableItemGraphContexts.Context, ...IJsonLdContextDefinitionElement[]];
     /**
      * JSON-LD Type.
      */
     type: typeof AuditableItemGraphTypes.PatchOperation;
     /**
      * The operation that was performed on the item.
+     * @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
      */
     patchPath: string;
     /**
      * The path the value was copied or moved from.
+     * @json-ld type:sch:Text
      */
     patchFrom?: string;
     /**
      * The value to add.
+     * @json-ld type:json
      */
     patchValue?: unknown;
 }

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

@@ -9,13 +9,14 @@ export interface IAuditableItemGraphResource extends IAuditableItemGraphAuditedE
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphContexts.Namespace | [typeof AuditableItemGraphContexts.Namespace, ...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
      */
     resourceObject?: IJsonLdNodeObject;
 }

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

@@ -3,7 +3,6 @@ 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";
 /**
@@ -14,8 +13,8 @@ export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAudit
      * JSON-LD Context.
      */
     "@context": [
-        typeof AuditableItemGraphContexts.Namespace,
-        typeof AuditableItemGraphContexts.NamespaceCommon,
+        typeof AuditableItemGraphContexts.Context,
+        typeof AuditableItemGraphContexts.ContextCommon,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**
@@ -28,30 +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
      */
     organizationIdentity?: string;
     /**
      * The JSON-LD annotation object for the vertex.
+     * @json-ld namespace:twin-common
      */
     annotationObject?: IJsonLdNodeObject;
     /**
      * Alternative aliases that can be used to identify the vertex.
+     * @json-ld container:set
      */
     aliases?: IAuditableItemGraphAlias[];
     /**
      * The resources attached to the vertex.
+     * @json-ld container:set
      */
     resources?: IAuditableItemGraphResource[];
     /**
      * Edges connected to the vertex.
+     * @json-ld container:set
      */
     edges?: IAuditableItemGraphEdge[];
-    /**
-     * Changesets for the vertex.
-     */
-    changesets?: IAuditableItemGraphChangeset[];
     /**
      * Is the vertex verified, will only be populated when verification is requested.
+     * @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

@@ -11,8 +11,8 @@ export interface IAuditableItemGraphVertexList {
      * JSON-LD Context.
      */
     "@context": [
-        typeof SchemaOrgContexts.Namespace,
-        typeof AuditableItemGraphContexts.Namespace,
+        typeof SchemaOrgContexts.Context,
+        typeof AuditableItemGraphContexts.Context,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**
@@ -21,10 +21,7 @@ export interface IAuditableItemGraphVertexList {
     type: [typeof SchemaOrgTypes.ItemList, typeof AuditableItemGraphTypes.VertexList];
     /**
      * The list of vertices.
+     * @json-ld namespace:sch
      */
     [SchemaOrgTypes.ItemListElement]: IAuditableItemGraphVertex[];
-    /**
-     * The cursor to get the next chunk of vertices.
-     */
-    [SchemaOrgTypes.NextItem]?: string;
 }

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/IAuditableItemGraphChangesetGetRequest.d.ts

@@ -0,0 +1,35 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { VerifyDepth } from "../verifyDepth.js";
+/**
+ * Get an auditable item graph vertex changeset.
+ */
+export interface IAuditableItemGraphChangesetGetRequest {
+    /**
+     * 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 to get the changeset from.
+         */
+        id: string;
+        /**
+         * The id of the changeset to get.
+         */
+        changesetId: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * How many signatures to verify, none, current or all, defaults to "none".
+         */
+        verifySignatureDepth?: VerifyDepth;
+    };
+}

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

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IAuditableItemGraphChangeset } from "../IAuditableItemGraphChangeset.js";
+/**
+ * Response to getting an auditable item graph vertex changeset.
+ */
+export interface IAuditableItemGraphChangesetGetResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The response body.
+     */
+    body: IAuditableItemGraphChangeset;
+}

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

@@ -0,0 +1,39 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { VerifyDepth } from "../verifyDepth.js";
+/**
+ * Get an auditable item graph changeset.
+ */
+export interface IAuditableItemGraphChangesetListRequest {
+    /**
+     * 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 changeset to get.
+         */
+        id: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * The optional cursor to get next chunk.
+         */
+        cursor?: string;
+        /**
+         * Limit the number of entities to return.
+         */
+        limit?: string;
+        /**
+         * How many signatures to verify, none, current or all, defaults to "none".
+         */
+        verifySignatureDepth?: VerifyDepth;
+    };
+}

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

@@ -0,0 +1,18 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IAuditableItemGraphChangesetList } from "../IAuditableItemGraphChangesetList.js";
+/**
+ * Response to getting an auditable item graph changeset list.
+ */
+export interface IAuditableItemGraphChangesetListResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+        [HeaderTypes.Link]?: string | string[];
+    };
+    /**
+     * The response body.
+     */
+    body: IAuditableItemGraphChangesetList;
+}

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/IAuditableItemGraphGetRequest.d.ts

@@ -27,10 +27,6 @@ export interface IAuditableItemGraphGetRequest {
          * Whether to include deleted aliases, resource, edges, defaults to false.
          */
         includeDeleted?: string;
-        /**
-         * Whether to include the changesets of the vertex, defaults to false.
-         */
-        includeChangesets?: string;
         /**
          * How many signatures to verify, none, current or all, defaults to "none".
          */

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

@@ -9,6 +9,7 @@ export interface IAuditableItemGraphListResponse {
      */
     headers?: {
         [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+        [HeaderTypes.Link]?: string | string[];
     };
     /**
      * The response payload.

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/auditableItemGraphContexts.d.ts

@@ -3,13 +3,29 @@
  */
 export declare const AuditableItemGraphContexts: {
     /**
-     * The namespace for the auditable item graph types.
+     * The canonical RDF namespace URI for Auditable Item Graph.
      */
     readonly Namespace: "https://schema.twindev.org/aig/";
     /**
-     * The namespace for the common types.
+     * The value to use in context for Auditable Item Graph.
+     */
+    readonly Context: "https://schema.twindev.org/aig/";
+    /**
+     * The JSON-LD Context URL for Auditable Item Graph.
+     */
+    readonly JsonLdContext: "https://schema.twindev.org/aig/types.jsonld";
+    /**
+     * The canonical RDF namespace URI for TWIN Common.
      */
     readonly NamespaceCommon: "https://schema.twindev.org/common/";
+    /**
+     * The value to use in JSON-LD context for TWIN Common.
+     */
+    readonly ContextCommon: "https://schema.twindev.org/common/";
+    /**
+     * The JSON-LD Context URL for TWIN Common.
+     */
+    readonly JsonLdContextCommon: "https://schema.twindev.org/common/types.jsonld";
 };
 /**
  * The contexts of auditable item graph data.