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

package/docs/reference/classes/AuditableItemGraphRestClient.md

@@ -0,0 +1,468 @@
+# Class: AuditableItemGraphRestClient
+
+Client for performing auditable item graph through to REST endpoints.
+
+## Extends
+
+- `BaseRestClient`
+
+## Implements
+
+- `IAuditableItemGraphComponent`
+
+## Constructors
+
+### Constructor
+
+> **new AuditableItemGraphRestClient**(`config`): `AuditableItemGraphRestClient`
+
+Create a new instance of AuditableItemGraphRestClient.
+
+#### Parameters
+
+##### config
+
+`IBaseRestClientConfig`
+
+The configuration for the client.
+
+#### Returns
+
+`AuditableItemGraphRestClient`
+
+#### Overrides
+
+`BaseRestClient.constructor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.className`
+
+***
+
+### create() {#create}
+
+> **create**(`vertex`): `Promise`\<`string`\>
+
+Create a new graph vertex.
+
+#### Parameters
+
+##### vertex
+
+`Omit`\<`IAuditableItemGraphVertex`, `"id"`\>
+
+The vertex to create.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the new graph item.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.create`
+
+***
+
+### get() {#get}
+
+> **get**(`id`, `options?`): `Promise`\<`IAuditableItemGraphVertex`\>
+
+Get a graph vertex.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex to get.
+
+##### options?
+
+Additional options for the get operation.
+
+###### includeDeleted?
+
+`boolean`
+
+Whether to include deleted/updated aliases, resource, edges, defaults to false.
+
+###### verifySignatureDepth?
+
+`VerifyDepth`
+
+How many signatures to verify, defaults to "none".
+
+#### Returns
+
+`Promise`\<`IAuditableItemGraphVertex`\>
+
+The vertex if found.
+
+#### Throws
+
+NotFoundError if the vertex is not found.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.get`
+
+***
+
+### getChangesets() {#getchangesets}
+
+> **getChangesets**(`id`, `cursor?`, `limit?`, `options?`): `Promise`\<\{ `changesets`: `IAuditableItemGraphChangesetList`; `cursor?`: `string`; \}\>
+
+Get a graph vertex changeset list.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex to get.
+
+##### cursor?
+
+`string`
+
+The optional cursor to get next chunk.
+
+##### limit?
+
+`number`
+
+Limit the number of entities to return.
+
+##### options?
+
+Additional options for the get operation.
+
+###### verifySignatureDepth?
+
+`VerifyDepth`
+
+How many signatures to verify, defaults to "none".
+
+#### Returns
+
+`Promise`\<\{ `changesets`: `IAuditableItemGraphChangesetList`; `cursor?`: `string`; \}\>
+
+The changesets if found.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.getChangesets`
+
+***
+
+### getChangeset() {#getchangeset}
+
+> **getChangeset**(`id`, `options?`): `Promise`\<`IAuditableItemGraphChangeset`\>
+
+Get a graph vertex changeset.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex to get.
+
+##### options?
+
+Additional options for the get operation.
+
+###### verifySignatureDepth?
+
+`VerifyDepth`
+
+How many signatures to verify, defaults to "none".
+
+#### Returns
+
+`Promise`\<`IAuditableItemGraphChangeset`\>
+
+The changeset if found.
+
+#### Throws
+
+NotFoundError if the vertex or changeset is not found.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.getChangeset`
+
+***
+
+### getVersion() {#getversion}
+
+> **getVersion**(`id`, `version`): `Promise`\<`IAuditableItemGraphVertex`\>
+
+Get a graph vertex at a specific version.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex.
+
+##### version
+
+`number`
+
+The version number to retrieve.
+
+#### Returns
+
+`Promise`\<`IAuditableItemGraphVertex`\>
+
+The vertex reconstructed at that version.
+
+#### Throws
+
+NotFoundError if the vertex or version is not found.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.getVersion`
+
+***
+
+### getVersions() {#getversions}
+
+> **getVersions**(`id`, `options?`): `Promise`\<`IAuditableItemGraphVertexVersionList`\>
+
+Get all versions of a graph vertex.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex.
+
+##### options?
+
+Additional options for the operation.
+
+###### after?
+
+`string`
+
+Only return versions created after this ISO 8601 timestamp (exclusive).
+
+###### before?
+
+`string`
+
+Only return versions created before this ISO 8601 timestamp (exclusive).
+
+#### Returns
+
+`Promise`\<`IAuditableItemGraphVertexVersionList`\>
+
+The list of vertex versions.
+
+#### Throws
+
+NotFoundError if the vertex is not found.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.getVersions`
+
+***
+
+### update() {#update}
+
+> **update**(`vertex`): `Promise`\<`void`\>
+
+Update a graph vertex (PUT - full replacement of vertex state).
+The server serializes concurrent updates for the same vertex via `Mutex` on the vertex id;
+requests load-balanced across replicas can still race.
+
+#### Parameters
+
+##### vertex
+
+`IAuditableItemGraphVertex`
+
+The vertex to update.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the vertex has been updated.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.update`
+
+***
+
+### updatePartial() {#updatepartial}
+
+> **updatePartial**(`partial`): `Promise`\<`void`\>
+
+Partially update a graph vertex (PATCH - optional scalars; list fields use `{ add, remove }`).
+
+#### Parameters
+
+##### partial
+
+`IAuditableItemGraphPartialVertex`
+
+The partial vertex update (must include `id`).
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the partial update has been applied.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.updatePartial`
+
+***
+
+### removeProof() {#removeproof}
+
+> **removeProof**(`id`): `Promise`\<`void`\>
+
+Remove the notarization proof from all changesets of a graph vertex.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the proof has been removed.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.removeProof`
+
+***
+
+### query() {#query}
+
+> **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
+
+Query the graph for vertices.
+
+#### Parameters
+
+##### options?
+
+The query options.
+
+###### id?
+
+`string`
+
+The optional id to look for.
+
+###### idMode?
+
+`"id"` \| `"alias"` \| `"both"`
+
+Look in id, alias or both, defaults to both.
+
+###### idExact?
+
+`boolean`
+
+Find only exact matches, default to false meaning partial matching.
+
+###### resourceTypes?
+
+`string`[]
+
+Include vertices with specific resource types.
+
+##### conditions?
+
+`EntityCondition`\<`IAuditableItemGraphVertex`\>
+
+Conditions to use in the query.
+
+##### orderBy?
+
+`"dateCreated"` \| `"dateModified"`
+
+The order for the results, defaults to created.
+
+##### orderByDirection?
+
+`SortDirection`
+
+The direction for the order, defaults to descending.
+
+##### properties?
+
+(keyof `IAuditableItemGraphVertex`)[]
+
+The properties to return, if not provided defaults to id, created, aliases and object.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next chunk of entities.
+
+##### limit?
+
+`number`
+
+The maximum number of entities to return, a page can contain fewer so follow
+the cursor until it is absent to read them all.
+
+#### Returns
+
+`Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
+
+The entities, which can be partial if a limited keys list was provided.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.query`

package/docs/reference/index.md

@@ -0,0 +1,5 @@
+# @3sixty/auditable-item-graph-rest-client
+
+## Classes
+
+- [AuditableItemGraphRestClient](classes/AuditableItemGraphRestClient.md)

package/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -1,6 +1,55 @@
 {
-  "name": "@3sixty/auditable-item-graph-rest-client",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/auditable-item-graph-rest-client",
+	"version": "0.20.0-next.1",
+	"description": "Provides a client for interacting with auditable graph endpoints over HTTP.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/auditable-item-graph.git",
+		"directory": "packages/auditable-item-graph-rest-client"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/api-core": "next",
+		"@3sixty/api-models": "next",
+		"@3sixty/auditable-item-graph-models": "0.20.0-next.1",
+		"@3sixty/core": "next",
+		"@3sixty/data-json-ld": "next",
+		"@3sixty/entity": "next",
+		"@3sixty/immutable-proof-models": "next",
+		"@3sixty/nameof": "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"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/auditable-item-graph/issues"
+	},
+	"homepage": "https://3sixty.global"
+}