@twin.org/auditable-item-graph-service 0.0.1-next.3

package/docs/reference/functions/auditableItemGraphGet.md

@@ -0,0 +1,25 @@
+# Function: auditableItemGraphGet()
+
+> **auditableItemGraphGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemGraphGetResponse`\>
+
+Get the graph vertex.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `IAuditableItemGraphGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemGraphGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphList.md

@@ -0,0 +1,25 @@
+# Function: auditableItemGraphList()
+
+> **auditableItemGraphList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemGraphListResponse`\>
+
+Query the graph vertices.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `IAuditableItemGraphListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemGraphListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphUpdate.md

@@ -0,0 +1,25 @@
+# Function: auditableItemGraphUpdate()
+
+> **auditableItemGraphUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Update the graph vertex.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `IAuditableItemGraphUpdateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/generateRestRoutesAuditableItemGraph.md

@@ -0,0 +1,21 @@
+# Function: generateRestRoutesAuditableItemGraph()
+
+> **generateRestRoutesAuditableItemGraph**(`baseRouteName`, `componentName`): `IRestRoute`[]
+
+The REST routes for auditable item graph.
+
+## Parameters
+
+• **baseRouteName**: `string`
+
+Prefix to prepend to the paths.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+## Returns
+
+`IRestRoute`[]
+
+The generated routes.

package/docs/reference/functions/initSchema.md

@@ -0,0 +1,9 @@
+# Function: initSchema()
+
+> **initSchema**(): `void`
+
+Initialize the schema for the auditable item graph entity storage connector.
+
+## Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,29 @@
+# @twin.org/auditable-item-graph-service
+
+## Classes
+
+- [AuditableItemGraphService](classes/AuditableItemGraphService.md)
+- [AuditableItemGraphAlias](classes/AuditableItemGraphAlias.md)
+- [AuditableItemGraphChangeset](classes/AuditableItemGraphChangeset.md)
+- [AuditableItemGraphEdge](classes/AuditableItemGraphEdge.md)
+- [AuditableItemGraphPatch](classes/AuditableItemGraphPatch.md)
+- [AuditableItemGraphResource](classes/AuditableItemGraphResource.md)
+- [AuditableItemGraphVertex](classes/AuditableItemGraphVertex.md)
+
+## Interfaces
+
+- [IAuditableItemGraphServiceConfig](interfaces/IAuditableItemGraphServiceConfig.md)
+
+## Variables
+
+- [tagsAuditableItemGraph](variables/tagsAuditableItemGraph.md)
+- [restEntryPoints](variables/restEntryPoints.md)
+
+## Functions
+
+- [generateRestRoutesAuditableItemGraph](functions/generateRestRoutesAuditableItemGraph.md)
+- [auditableItemGraphCreate](functions/auditableItemGraphCreate.md)
+- [auditableItemGraphGet](functions/auditableItemGraphGet.md)
+- [auditableItemGraphUpdate](functions/auditableItemGraphUpdate.md)
+- [auditableItemGraphList](functions/auditableItemGraphList.md)
+- [initSchema](functions/initSchema.md)

package/docs/reference/interfaces/IAuditableItemGraphServiceConfig.md

@@ -0,0 +1,46 @@
+# Interface: IAuditableItemGraphServiceConfig
+
+Configuration for the auditable item graph service.
+
+## Properties
+
+### vaultKeyId?
+
+> `optional` **vaultKeyId**: `string`
+
+The key to use for the graph.
+
+#### Default
+
+```ts
+auditable-item-graph
+```
+
+***
+
+### enableImmutableDiffs?
+
+> `optional` **enableImmutableDiffs**: `boolean`
+
+Enable immutable diffs by storing the changes encrypted in immutable storage.
+This will incur additional costs and should only be enabled if you require immutable integrity checking.
+
+#### Default
+
+```ts
+false
+```
+
+***
+
+### assertionMethodId?
+
+> `optional` **assertionMethodId**: `string`
+
+The assertion method id to use for the graph.
+
+#### Default
+
+```ts
+auditable-item-graph
+```

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,3 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]

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,19 @@
+{
+	"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",
+			"updatingFailed": "Updating the Auditable Item Graph vertex failed",
+			"queryingFailed": "Querying the Auditable Item Graph failed",
+			"removeImmutableFailed": "Removing the immutable data the Auditable Item Graph vertex failed",
+			"vertexNotFound": "The vertex with the Id \"{notFoundId}\" was not found",
+			"changesetCredentialRevoked": "The verification credential for the changeset has been revoked",
+			"invalidChangesetHash": "The changeset with epoch \"{epoch}\" and hash \"{hash}\" is invalid",
+			"invalidChangesetSignature": "The changeset with epoch \"{epoch}\" and hash \"{hash}\" signature does not match the changeset signature",
+			"immutableChangesetSignature": "The changeset with epoch \"{epoch}\" and hash \"{hash}\" signature does not match the immutable changeset signature",
+			"invalidChangesetCanonical": "The changeset with epoch \"{epoch}\" and hash \"{hash}\" integrity check does not match the immutable changeset integrity check"
+		}
+	},
+	"auditableItemGraphService": {}
+}

package/package.json

@@ -0,0 +1,85 @@
+{
+	"name": "@twin.org/auditable-item-graph-service",
+	"version": "0.0.1-next.3",
+	"description": "Auditable Item Graph contract implementation and REST endpoint definitions",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/auditable-item-graph.git",
+		"directory": "packages/auditable-item-graph-service"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"scripts": {
+		"clean": "rimraf dist coverage docs/reference",
+		"build": "tspc",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs:api": "ts-to-openapi ./ts-to-openapi.json ./docs/open-api/spec.json",
+		"docs": "npm run docs:clean && npm run docs:generate && npm run docs:api",
+		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
+	},
+	"dependencies": {
+		"@twin.org/api-models": "next",
+		"@twin.org/auditable-item-graph-models": "0.0.1-next.3",
+		"@twin.org/core": "next",
+		"@twin.org/crypto": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-models": "next",
+		"@twin.org/identity-models": "next",
+		"@twin.org/immutable-storage-models": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-w3c-did": "next",
+		"@twin.org/vault-models": "next",
+		"@twin.org/web": "next",
+		"jsonschema": "1.4.1",
+		"rfc6902": "5.1.1"
+	},
+	"devDependencies": {
+		"@twin.org/data-schema-org": "next",
+		"@twin.org/entity-storage-connector-memory": "next",
+		"@twin.org/identity-connector-entity-storage": "next",
+		"@twin.org/immutable-storage-connector-entity-storage": "next",
+		"@twin.org/vault-connector-entity-storage": "next",
+		"@twin.org/nameof-transformer": "next",
+		"@twin.org/ts-to-openapi": "next",
+		"@types/node": "22.5.5",
+		"@vitest/coverage-v8": "2.1.1",
+		"copyfiles": "2.4.1",
+		"rimraf": "6.0.1",
+		"rollup": "4.22.0",
+		"rollup-plugin-typescript2": "0.36.0",
+		"ts-patch": "3.2.1",
+		"typedoc": "0.26.7",
+		"typedoc-plugin-markdown": "4.2.7",
+		"typescript": "5.6.2",
+		"vitest": "2.1.1"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}