@3sixty/auditable-item-graph-models 0.0.0-stage → 0.20.0-next.1

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

@@ -0,0 +1,33 @@
+/**
+ * The contexts of auditable item graph data.
+ */
+export declare const AuditableItemGraphContexts: {
+    /**
+     * The canonical RDF namespace URI for Auditable Item Graph.
+     */
+    readonly Namespace: "https://schema.3sixty.global/aig/";
+    /**
+     * The value to use in context for Auditable Item Graph.
+     */
+    readonly Context: "https://schema.3sixty.global/aig/";
+    /**
+     * The JSON-LD Context URL for Auditable Item Graph.
+     */
+    readonly JsonLdContext: "https://schema.3sixty.global/aig/types.jsonld";
+    /**
+     * The canonical RDF namespace URI for TWIN Common.
+     */
+    readonly NamespaceCommon: "https://schema.3sixty.global/common/";
+    /**
+     * The value to use in JSON-LD context for TWIN Common.
+     */
+    readonly ContextCommon: "https://schema.3sixty.global/common/";
+    /**
+     * The JSON-LD Context URL for TWIN Common.
+     */
+    readonly JsonLdContextCommon: "https://schema.3sixty.global/common/types.jsonld";
+};
+/**
+ * The contexts of auditable item graph data.
+ */
+export type AuditableItemGraphContexts = (typeof AuditableItemGraphContexts)[keyof typeof AuditableItemGraphContexts];

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 "@3sixty/telemetry-models";
+/**
+ * Metrics registered by the auditable item graph service.
+ */
+export declare const AuditableItemGraphMetrics: ITelemetryMetric[];

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

@@ -0,0 +1,17 @@
+/**
+ * The topics for auditable item graph event bus notifications.
+ */
+export declare const AuditableItemGraphTopics: {
+    /**
+     * A vertex was created.
+     */
+    readonly VertexCreated: "auditable-item-graph:vertex-created";
+    /**
+     * A vertex was updated.
+     */
+    readonly VertexUpdated: "auditable-item-graph:vertex-updated";
+};
+/**
+ * The topics for auditable item graph event bus notifications.
+ */
+export type AuditableItemGraphTopics = (typeof AuditableItemGraphTopics)[keyof typeof AuditableItemGraphTopics];

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

@@ -0,0 +1,57 @@
+/**
+ * The types of auditable item graph data.
+ */
+export declare const AuditableItemGraphTypes: {
+    /**
+     * Represents auditable item graph vertex.
+     */
+    readonly Vertex: "AuditableItemGraphVertex";
+    /**
+     * Represents auditable item graph vertex list.
+     */
+    readonly VertexList: "AuditableItemGraphVertexList";
+    /**
+     * Represents auditable item graph alias.
+     */
+    readonly Alias: "AuditableItemGraphAlias";
+    /**
+     * Represents auditable item graph resource.
+     */
+    readonly Resource: "AuditableItemGraphResource";
+    /**
+     * Represents auditable item graph edge.
+     */
+    readonly Edge: "AuditableItemGraphEdge";
+    /**
+     * Represents auditable item graph changeset.
+     */
+    readonly Changeset: "AuditableItemGraphChangeset";
+    /**
+     * Represents auditable item graph changeset list.
+     */
+    readonly ChangesetList: "AuditableItemGraphChangesetList";
+    /**
+     * 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";
+    /**
+     * Represents auditable item graph audit mode.
+     */
+    readonly AuditMode: "AuditableItemGraphAuditMode";
+};
+/**
+ * The types of auditable item graph data.
+ */
+export type AuditableItemGraphTypes = (typeof AuditableItemGraphTypes)[keyof typeof AuditableItemGraphTypes];

package/dist/types/models/eventBus/IAuditableItemGraphEventBusVertexCreated.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Event bus payload for vertex created.
+ */
+export interface IAuditableItemGraphEventBusVertexCreated {
+    /**
+     * The id of the vertex created.
+     */
+    id: string;
+}

package/dist/types/models/eventBus/IAuditableItemGraphEventBusVertexUpdated.d.ts

@@ -0,0 +1,14 @@
+import type { IPatchOperation } from "@3sixty/core";
+/**
+ * Event bus payload for vertex updated.
+ */
+export interface IAuditableItemGraphEventBusVertexUpdated {
+    /**
+     * The id of the vertex updated.
+     */
+    id: string;
+    /**
+     * The patches in the changeset.
+     */
+    patches: IPatchOperation[];
+}

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

@@ -0,0 +1,21 @@
+/**
+ * How deep to verify the signatures.
+ */
+export declare const VerifyDepth: {
+    /**
+     * Do not verify any signatures.
+     */
+    readonly None: "none";
+    /**
+     * Verify only the most recent signature.
+     */
+    readonly Current: "current";
+    /**
+     * Verify all the signatures.
+     */
+    readonly All: "all";
+};
+/**
+ * How deep to verify the signatures.
+ */
+export type VerifyDepth = (typeof VerifyDepth)[keyof typeof VerifyDepth];

package/docs/changelog.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [0.20.0-next.1](https://github.com/3sixtyglobal/auditable-item-graph/compare/auditable-item-graph-models-v0.20.0-next.0...auditable-item-graph-models-v0.20.0-next.1) (2026-10-23)
+
+
+### Features
+
+* publish packages under the [@3sixty](https://github.com/3sixty) namespace ([69a615e](https://github.com/3sixtyglobal/auditable-item-graph/commit/69a615ed9a59cc91795d1f8fd65cc778cea7e783))
+* updated ts compile ([5631c11](https://github.com/3sixtyglobal/auditable-item-graph/commit/5631c11fa969a8917e68253c50bf962c10e75814))

package/docs/examples.md

@@ -0,0 +1,22 @@
+# Auditable Item Graph Models Examples
+
+Use these examples to initialise data type handling before interacting with graph APIs and JSON-LD payloads.
+
+## AuditableItemGraphDataTypes
+
+```typescript
+import { DataTypeHandlerFactory } from '@3sixty/data-core';
+import {
+  AuditableItemGraphContexts,
+  AuditableItemGraphDataTypes,
+  AuditableItemGraphTypes
+} from '@3sixty/auditable-item-graph-models';
+
+AuditableItemGraphDataTypes.registerTypes();
+
+const vertexType = `${AuditableItemGraphContexts.Namespace}${AuditableItemGraphTypes.Vertex}`;
+const handler = DataTypeHandlerFactory.get(vertexType);
+
+console.log(vertexType); // https://schema.3sixty.global/auditable-item-graph/Vertex
+console.log(handler.type); // Vertex
+```

package/docs/reference/classes/AuditableItemGraphDataTypes.md

@@ -0,0 +1,25 @@
+# Class: AuditableItemGraphDataTypes
+
+Handle all the data types for auditable item graph.
+
+## Constructors
+
+### Constructor
+
+> **new AuditableItemGraphDataTypes**(): `AuditableItemGraphDataTypes`
+
+#### Returns
+
+`AuditableItemGraphDataTypes`
+
+## Methods
+
+### registerTypes() {#registertypes}
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,71 @@
+# @3sixty/auditable-item-graph-models
+
+## Classes
+
+- [AuditableItemGraphDataTypes](classes/AuditableItemGraphDataTypes.md)
+
+## Interfaces
+
+- [IAuditableItemGraphAlias](interfaces/IAuditableItemGraphAlias.md)
+- [IAuditableItemGraphAuditedElement](interfaces/IAuditableItemGraphAuditedElement.md)
+- [IAuditableItemGraphChangeset](interfaces/IAuditableItemGraphChangeset.md)
+- [IAuditableItemGraphChangesetList](interfaces/IAuditableItemGraphChangesetList.md)
+- [IAuditableItemGraphComponent](interfaces/IAuditableItemGraphComponent.md)
+- [IAuditableItemGraphEdge](interfaces/IAuditableItemGraphEdge.md)
+- [IAuditableItemGraphListPatch](interfaces/IAuditableItemGraphListPatch.md)
+- [IAuditableItemGraphPartialVertex](interfaces/IAuditableItemGraphPartialVertex.md)
+- [IAuditableItemGraphPatchOperation](interfaces/IAuditableItemGraphPatchOperation.md)
+- [IAuditableItemGraphResource](interfaces/IAuditableItemGraphResource.md)
+- [IAuditableItemGraphVertex](interfaces/IAuditableItemGraphVertex.md)
+- [IAuditableItemGraphVertexList](interfaces/IAuditableItemGraphVertexList.md)
+- [IAuditableItemGraphVertexVersionList](interfaces/IAuditableItemGraphVertexVersionList.md)
+- [IAuditableItemGraphChangesetGetRequest](interfaces/IAuditableItemGraphChangesetGetRequest.md)
+- [IAuditableItemGraphChangesetGetResponse](interfaces/IAuditableItemGraphChangesetGetResponse.md)
+- [IAuditableItemGraphChangesetListRequest](interfaces/IAuditableItemGraphChangesetListRequest.md)
+- [IAuditableItemGraphChangesetListResponse](interfaces/IAuditableItemGraphChangesetListResponse.md)
+- [IAuditableItemGraphCreateRequest](interfaces/IAuditableItemGraphCreateRequest.md)
+- [IAuditableItemGraphGetRequest](interfaces/IAuditableItemGraphGetRequest.md)
+- [IAuditableItemGraphGetResponse](interfaces/IAuditableItemGraphGetResponse.md)
+- [IAuditableItemGraphListRequest](interfaces/IAuditableItemGraphListRequest.md)
+- [IAuditableItemGraphListResponse](interfaces/IAuditableItemGraphListResponse.md)
+- [IAuditableItemGraphRemoveProofRequest](interfaces/IAuditableItemGraphRemoveProofRequest.md)
+- [IAuditableItemGraphUpdatePartialRequest](interfaces/IAuditableItemGraphUpdatePartialRequest.md)
+- [IAuditableItemGraphUpdateRequest](interfaces/IAuditableItemGraphUpdateRequest.md)
+- [IAuditableItemGraphVersionGetRequest](interfaces/IAuditableItemGraphVersionGetRequest.md)
+- [IAuditableItemGraphVersionGetResponse](interfaces/IAuditableItemGraphVersionGetResponse.md)
+- [IAuditableItemGraphVersionListRequest](interfaces/IAuditableItemGraphVersionListRequest.md)
+- [IAuditableItemGraphVersionListResponse](interfaces/IAuditableItemGraphVersionListResponse.md)
+- [IAuditableItemGraphEventBusVertexCreated](interfaces/IAuditableItemGraphEventBusVertexCreated.md)
+- [IAuditableItemGraphEventBusVertexUpdated](interfaces/IAuditableItemGraphEventBusVertexUpdated.md)
+
+## Type Aliases
+
+- [AuditableItemGraphAuditMode](type-aliases/AuditableItemGraphAuditMode.md)
+- [AuditableItemGraphContexts](type-aliases/AuditableItemGraphContexts.md)
+- [AuditableItemGraphMetricIds](type-aliases/AuditableItemGraphMetricIds.md)
+- [AuditableItemGraphTopics](type-aliases/AuditableItemGraphTopics.md)
+- [AuditableItemGraphTypes](type-aliases/AuditableItemGraphTypes.md)
+- [VerifyDepth](type-aliases/VerifyDepth.md)
+
+## Variables
+
+- [CompiledAuditableItemGraphAuditMode](variables/CompiledAuditableItemGraphAuditMode.md)
+- [CompiledAuditableItemGraphAlias](variables/CompiledAuditableItemGraphAlias.md)
+- [CompiledAuditableItemGraphAuditedElement](variables/CompiledAuditableItemGraphAuditedElement.md)
+- [CompiledAuditableItemGraphChangeset](variables/CompiledAuditableItemGraphChangeset.md)
+- [CompiledAuditableItemGraphChangesetList](variables/CompiledAuditableItemGraphChangesetList.md)
+- [CompiledAuditableItemGraphEdge](variables/CompiledAuditableItemGraphEdge.md)
+- [CompiledAuditableItemGraphListPatch](variables/CompiledAuditableItemGraphListPatch.md)
+- [CompiledAuditableItemGraphPartialVertex](variables/CompiledAuditableItemGraphPartialVertex.md)
+- [CompiledAuditableItemGraphPatchOperation](variables/CompiledAuditableItemGraphPatchOperation.md)
+- [CompiledAuditableItemGraphResource](variables/CompiledAuditableItemGraphResource.md)
+- [CompiledAuditableItemGraphVertex](variables/CompiledAuditableItemGraphVertex.md)
+- [CompiledAuditableItemGraphVertexList](variables/CompiledAuditableItemGraphVertexList.md)
+- [CompiledAuditableItemGraphVertexVersionList](variables/CompiledAuditableItemGraphVertexVersionList.md)
+- [AuditableItemGraphAuditMode](variables/AuditableItemGraphAuditMode.md)
+- [AuditableItemGraphContexts](variables/AuditableItemGraphContexts.md)
+- [AuditableItemGraphMetricIds](variables/AuditableItemGraphMetricIds.md)
+- [AuditableItemGraphMetrics](variables/AuditableItemGraphMetrics.md)
+- [AuditableItemGraphTopics](variables/AuditableItemGraphTopics.md)
+- [AuditableItemGraphTypes](variables/AuditableItemGraphTypes.md)
+- [VerifyDepth](variables/VerifyDepth.md)

package/docs/reference/interfaces/IAuditableItemGraphAlias.md

@@ -0,0 +1,95 @@
+# Interface: IAuditableItemGraphAlias
+
+Interface describing an alias for a vertex.
+
+## Extends
+
+- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md)
+
+## Properties
+
+### @context? {#context}
+
+> `optional` **@context?**: `"https://schema.3sixty.global/aig/"` \| \[`"https://schema.3sixty.global/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### id {#id}
+
+> **id**: `string`
+
+The id of the element.
+
+#### Overrides
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
+
+***
+
+### type {#type}
+
+> **type**: `"AuditableItemGraphAlias"`
+
+JSON-LD Type.
+
+***
+
+### annotationObject? {#annotationobject}
+
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
+
+The JSON-LD annotation object for the alias.
+
+***
+
+### aliasFormat? {#aliasformat}
+
+> `optional` **aliasFormat?**: `string`
+
+The format of the id in the alias.
+
+***
+
+### unique? {#unique}
+
+> `optional` **unique?**: `boolean`
+
+Whether the alias should be unique across the graph, meaning that no other vertex can have the same alias. Defaults to false.
+
+***
+
+### dateCreated? {#datecreated}
+
+> `optional` **dateCreated?**: `string`
+
+The date/time of when the element was created.
+
+#### Inherited from
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateCreated`](IAuditableItemGraphAuditedElement.md#datecreated)
+
+***
+
+### dateModified? {#datemodified}
+
+> `optional` **dateModified?**: `string`
+
+The date/time of when the element was modified.
+
+#### Inherited from
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateModified`](IAuditableItemGraphAuditedElement.md#datemodified)
+
+***
+
+### dateDeleted? {#datedeleted}
+
+> `optional` **dateDeleted?**: `string`
+
+The date/time of when the element was deleted, as we never actually remove items.
+
+#### Inherited from
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateDeleted`](IAuditableItemGraphAuditedElement.md#datedeleted)

package/docs/reference/interfaces/IAuditableItemGraphAuditedElement.md

@@ -0,0 +1,41 @@
+# Interface: IAuditableItemGraphAuditedElement
+
+Interface describing the base properties for auditable elements.
+
+## Extended by
+
+- [`IAuditableItemGraphAlias`](IAuditableItemGraphAlias.md)
+- [`IAuditableItemGraphEdge`](IAuditableItemGraphEdge.md)
+- [`IAuditableItemGraphResource`](IAuditableItemGraphResource.md)
+
+## Properties
+
+### id? {#id}
+
+> `optional` **id?**: `string`
+
+The id of the element.
+
+***
+
+### dateCreated? {#datecreated}
+
+> `optional` **dateCreated?**: `string`
+
+The date/time of when the element was created.
+
+***
+
+### dateModified? {#datemodified}
+
+> `optional` **dateModified?**: `string`
+
+The date/time of when the element was modified.
+
+***
+
+### dateDeleted? {#datedeleted}
+
+> `optional` **dateDeleted?**: `string`
+
+The date/time of when the element was deleted, as we never actually remove items.

package/docs/reference/interfaces/IAuditableItemGraphChangeset.md

@@ -0,0 +1,76 @@
+# Interface: IAuditableItemGraphChangeset
+
+Interface describing a set of changes to the vertex.
+
+## Properties
+
+### @context? {#context}
+
+> `optional` **@context?**: \[`"https://schema.3sixty.global/aig/"`, `"https://schema.3sixty.global/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type {#type}
+
+> **type**: `"AuditableItemGraphChangeset"`
+
+JSON-LD Type.
+
+***
+
+### id {#id}
+
+> **id**: `string`
+
+The id of the changeset.
+
+***
+
+### dateCreated {#datecreated}
+
+> **dateCreated**: `string`
+
+The date/time of when the changeset was created.
+
+***
+
+### userIdentity? {#useridentity}
+
+> `optional` **userIdentity?**: `string`
+
+The user identity that created the changes.
+
+***
+
+### patches {#patches}
+
+> **patches**: [`IAuditableItemGraphPatchOperation`](IAuditableItemGraphPatchOperation.md)[]
+
+The patches in the changeset.
+
+***
+
+### proofId? {#proofid}
+
+> `optional` **proofId?**: `string`
+
+The immutable proof id which contains the signature for this changeset.
+
+***
+
+### verification? {#verification}
+
+> `optional` **verification?**: `IImmutableProofVerification`
+
+The verification for the changeset.
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `number`
+
+The version number of the vertex after this changeset was applied.
+Maps to https://schema.org/version.

package/docs/reference/interfaces/IAuditableItemGraphChangesetGetRequest.md

@@ -0,0 +1,49 @@
+# Interface: IAuditableItemGraphChangesetGetRequest
+
+Get an auditable item graph vertex changeset.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the vertex to get the changeset from.
+
+#### changesetId
+
+> **changesetId**: `string`
+
+The id of the changeset to get.
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### verifySignatureDepth?
+
+> `optional` **verifySignatureDepth?**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
+
+How many signatures to verify, none, current or all, defaults to "none".

package/docs/reference/interfaces/IAuditableItemGraphChangesetGetResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAuditableItemGraphChangesetGetResponse
+
+Response to getting an auditable item graph vertex changeset.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body {#body}
+
+> **body**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)
+
+The response body.

package/docs/reference/interfaces/IAuditableItemGraphChangesetList.md

@@ -0,0 +1,27 @@
+# Interface: IAuditableItemGraphChangesetList
+
+Interface describing an auditable item graph changeset list.
+
+## Properties
+
+### @context {#context}
+
+> **@context**: \[`"https://schema.org"`, `"https://schema.3sixty.global/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type {#type}
+
+> **type**: \[`"ItemList"`, `"AuditableItemGraphChangesetList"`\]
+
+JSON-LD Type.
+
+***
+
+### itemListElement {#itemlistelement}
+
+> **itemListElement**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)[]
+
+The list of changesets.