@3sixty/auditable-item-graph-service 0.0.0-stage → 0.20.0-next.0

package/docs/reference/interfaces/IAuditableItemGraphServiceConfig.md

@@ -0,0 +1,11 @@
+# Interface: IAuditableItemGraphServiceConfig
+
+Configuration for the auditable item graph service.
+
+## Properties
+
+### mutexTimeoutMs? {#mutextimeoutms}
+
+> `optional` **mutexTimeoutMs?**: `number`
+
+Timeout in milliseconds for acquiring a mutex lock.

package/docs/reference/interfaces/IAuditableItemGraphServiceConstructorOptions.md

@@ -0,0 +1,83 @@
+# Interface: IAuditableItemGraphServiceConstructorOptions
+
+Options for the constructor of the auditable item graph service.
+
+## Properties
+
+### immutableProofComponentType? {#immutableproofcomponenttype}
+
+> `optional` **immutableProofComponentType?**: `string`
+
+The immutable proof component type.
+
+#### Default
+
+```ts
+immutable-proof
+```
+
+***
+
+### vertexEntityStorageType? {#vertexentitystoragetype}
+
+> `optional` **vertexEntityStorageType?**: `string`
+
+The entity storage for vertices.
+
+#### Default
+
+```ts
+auditable-item-graph-vertex
+```
+
+***
+
+### vertexIndexEntityStorageType? {#vertexindexentitystoragetype}
+
+> `optional` **vertexIndexEntityStorageType?**: `string`
+
+The entity storage for vertex indices.
+
+#### Default
+
+```ts
+auditable-item-graph-vertex-index
+```
+
+***
+
+### changesetEntityStorageType? {#changesetentitystoragetype}
+
+> `optional` **changesetEntityStorageType?**: `string`
+
+The entity storage for changesets.
+
+#### Default
+
+```ts
+auditable-item-graph-changeset
+```
+
+***
+
+### eventBusComponentType? {#eventbuscomponenttype}
+
+> `optional` **eventBusComponentType?**: `string`
+
+The event bus component type, defaults to no event bus.
+
+***
+
+### telemetryComponentType? {#telemetrycomponenttype}
+
+> `optional` **telemetryComponentType?**: `string`
+
+The component type for the optional telemetry component used for event metrics, defaults to no telemetry.
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IAuditableItemGraphServiceConfig`](IAuditableItemGraphServiceConfig.md)
+
+The configuration for the service.

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,5 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+The REST entry points for the auditable item graph service.

package/docs/reference/variables/tagsAuditableItemGraph.md

@@ -0,0 +1,5 @@
+# Variable: tagsAuditableItemGraph
+
+> `const` **tagsAuditableItemGraph**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -0,0 +1,34 @@
+{
+	"error": {
+		"auditableItemGraphService": {
+			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the Auditable Item Graph service \"{namespace}\"",
+			"createFailed": "Creating the Auditable Item Graph vertex failed",
+			"getFailed": "Getting the Auditable Item Graph vertex failed",
+			"getVersionFailed": "Getting the Auditable Item Graph vertex version failed",
+			"getVersionsFailed": "Getting the Auditable Item Graph vertex versions failed",
+			"versionNotFound": "The version with the Id \"{notFoundId}\" was not found",
+			"updatingFailed": "Updating the Auditable Item Graph vertex failed",
+			"queryingFailed": "Querying the Auditable Item Graph failed",
+			"removeProofFailed": "Removing the proof from the Auditable Item Graph vertex failed",
+			"vertexNotFound": "The vertex with the Id \"{notFoundId}\" was not found",
+			"changesetNotFound": "The changeset with the Id \"{notFoundId}\" was not found",
+			"resourceIdMissing": "You must provide either the id, or the resourceObject must contain an id property for index \"{index}\"",
+			"aliasNotUnique": "The alias id \"{aliasId}\" is already in use on another vertex and the unique flag was set",
+			"invalidEdgeId": "The edge id \"{edgeId}\" is not valid",
+			"listPatchInvalidFormat": "The property \"{property}\" must be a list patch object with add and/or remove, not a bare array",
+			"auditModeTransitionNotAllowed": "The vertex audit mode can not be changed from \"{currentMode}\" to \"{requestedMode}\", bypass is a terminal mode"
+		},
+		"validation": {
+			"auditableItemGraphService": {
+				"edgeIdSameAsVertexId": "The edge with target id \"{targetId}\" can not point to the vertex it belongs to"
+			}
+		}
+	},
+	"auditableItemGraphService": {},
+	"health": {
+		"auditableItemGraphService": {
+			"healthDescription": "Auditable item graph service application health check",
+			"getVertexFailed": "Failed to complete the auditable item graph vertex storage health check"
+		}
+	}
+}

package/package.json

@@ -1,6 +1,65 @@
 {
-  "name": "@3sixty/auditable-item-graph-service",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/auditable-item-graph-service",
+	"version": "0.20.0-next.0",
+	"description": "Implements graph lifecycle operations and audited change tracking with API route definitions.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/auditable-item-graph.git",
+		"directory": "packages/auditable-item-graph-service"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/api-models": "next",
+		"@3sixty/auditable-item-graph-models": "0.20.0-next.0",
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/crypto": "next",
+		"@3sixty/data-core": "next",
+		"@3sixty/data-json-ld": "next",
+		"@3sixty/entity": "next",
+		"@3sixty/entity-storage-models": "next",
+		"@3sixty/event-bus-models": "next",
+		"@3sixty/immutable-proof-models": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/standards-schema-org": "next",
+		"@3sixty/standards-w3c-did": "next",
+		"@3sixty/telemetry-models": "next",
+		"@3sixty/web": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"auditable-item-graph",
+		"service",
+		"microservice",
+		"business-logic"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/auditable-item-graph/issues"
+	},
+	"homepage": "https://3sixty.global"
+}