@twin.org/auditable-item-stream-service 0.0.3-next.2 → 0.0.3-next.21

package/docs/reference/index.md

@@ -23,6 +23,7 @@
 - [auditableItemStreamGet](functions/auditableItemStreamGet.md)
 - [auditableItemStreamUpdate](functions/auditableItemStreamUpdate.md)
 - [auditableItemStreamDelete](functions/auditableItemStreamDelete.md)
+- [auditableItemStreamClose](functions/auditableItemStreamClose.md)
 - [auditableItemStreamList](functions/auditableItemStreamList.md)
 - [auditableItemStreamCreateEntry](functions/auditableItemStreamCreateEntry.md)
 - [auditableItemStreamDeleteEntry](functions/auditableItemStreamDeleteEntry.md)
@@ -30,5 +31,8 @@
 - [auditableItemStreamGetEntry](functions/auditableItemStreamGetEntry.md)
 - [auditableItemStreamGetEntryObject](functions/auditableItemStreamGetEntryObject.md)
 - [auditableItemStreamListEntries](functions/auditableItemStreamListEntries.md)
+- [auditableItemStreamListEntriesNoStream](functions/auditableItemStreamListEntriesNoStream.md)
 - [auditableItemStreamListEntryObjects](functions/auditableItemStreamListEntryObjects.md)
+- [auditableItemStreamListEntryObjectsNoStream](functions/auditableItemStreamListEntryObjectsNoStream.md)
+- [auditableItemStreamRemoveProof](functions/auditableItemStreamRemoveProof.md)
 - [initSchema](functions/initSchema.md)

package/docs/reference/interfaces/IAuditableItemStreamServiceConfig.md

@@ -4,9 +4,9 @@ Configuration for the auditable item stream service.
 
 ## Properties
 
-### defaultImmutableInterval?
+### defaultImmutableInterval? {#defaultimmutableinterval}
 
-> `optional` **defaultImmutableInterval**: `number`
+> `optional` **defaultImmutableInterval?**: `number`
 
 After how many entries do we add immutable checks, defaults to service configured value.
 A value of 0 will disable integrity checks, 1 will be every item, or any other integer for an interval.

package/docs/reference/interfaces/IAuditableItemStreamServiceConstructorOptions.md

@@ -4,9 +4,9 @@ Options for the auditable item stream service constructor.
 
 ## Properties
 
-### immutableProofComponentType?
+### immutableProofComponentType? {#immutableproofcomponenttype}
 
-> `optional` **immutableProofComponentType**: `string`
+> `optional` **immutableProofComponentType?**: `string`
 
 The immutable proof component type.
 
@@ -18,9 +18,9 @@ immutable-proof
 
 ***
 
-### streamEntityStorageType?
+### streamEntityStorageType? {#streamentitystoragetype}
 
-> `optional` **streamEntityStorageType**: `string`
+> `optional` **streamEntityStorageType?**: `string`
 
 The entity storage for stream.
 
@@ -32,9 +32,9 @@ auditable-item-stream
 
 ***
 
-### streamEntryEntityStorageType?
+### streamEntryEntityStorageType? {#streamentryentitystoragetype}
 
-> `optional` **streamEntryEntityStorageType**: `string`
+> `optional` **streamEntryEntityStorageType?**: `string`
 
 The entity storage for stream entries.
 
@@ -46,16 +46,24 @@ auditable-item-stream-entry
 
 ***
 
-### eventBusComponentType?
+### eventBusComponentType? {#eventbuscomponenttype}
 
-> `optional` **eventBusComponentType**: `string`
+> `optional` **eventBusComponentType?**: `string`
 
 The event bus component type, defaults to no event bus.
 
 ***
 
-### config?
+### telemetryComponentType? {#telemetrycomponenttype}
 
-> `optional` **config**: [`IAuditableItemStreamServiceConfig`](IAuditableItemStreamServiceConfig.md)
+> `optional` **telemetryComponentType?**: `string`
+
+The component type for the optional telemetry component used for event metrics.
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IAuditableItemStreamServiceConfig`](IAuditableItemStreamServiceConfig.md)
 
 The configuration for the connector.

package/locales/en.json

@@ -4,6 +4,7 @@
 			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the Auditable Item Stream service \"{namespace}\"",
 			"createFailed": "Creating the Auditable Item Stream failed",
 			"getFailed": "Getting the Auditable Item Stream failed",
+			"closeFailed": "Closing the Auditable Item Stream failed",
 			"updatingFailed": "Updating the Auditable Item Stream failed",
 			"removingFailed": "Removing Auditable Item Stream failed",
 			"queryingFailed": "Querying the Auditable Item Stream failed",
@@ -14,7 +15,11 @@
 			"removingEntryFailed": "Removing entry from the Auditable Item Stream failed",
 			"gettingEntriesFailed": "Getting entries from the Auditable Item Stream failed",
 			"gettingEntryObjectsFailed": "Getting entry objects from the Auditable Item Stream failed",
-			"removeVerifiableFailed": "Removing verifiable storage from the Auditable Item Stream failed",
+			"removeProofFailed": "Removing proof from the Auditable Item Stream failed",
+			"closedRequiresEntries": "A stream can only be created as closed when entries are provided",
+			"streamClosed": "The stream with the Id \"{id}\" is closed and does not allow entry updates",
+			"appendOnlyNoEntryUpdates": "Entries in append-only mode cannot be updated for stream \"{id}\"",
+			"appendOnlyNoEntryRemovals": "Entries in append-only mode cannot be removed for stream \"{id}\"",
 			"streamNotFound": "The stream with the Id \"{notFoundId}\" was not found",
 			"streamEntryNotFound": "The stream entry with the Id \"{notFoundId}\" was not found"
 		}

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/auditable-item-stream-service",
-	"version": "0.0.3-next.2",
-	"description": "Auditable Item Stream contract implementation and REST endpoint definitions",
+	"version": "0.0.3-next.21",
+	"description": "Service implementation and REST route generation for managing auditable streams and entries.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/auditable-item-stream.git",
+		"url": "git+https://github.com/iotaledger/twin-auditable-item-stream.git",
 		"directory": "packages/auditable-item-stream-service"
 	},
 	"author": "martyn.janes@iota.org",
@@ -15,7 +15,7 @@
 	},
 	"dependencies": {
 		"@twin.org/api-models": "next",
-		"@twin.org/auditable-item-stream-models": "0.0.3-next.2",
+		"@twin.org/auditable-item-stream-models": "0.0.3-next.21",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
@@ -27,6 +27,7 @@
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-schema-org": "next",
 		"@twin.org/standards-w3c-did": "next",
+		"@twin.org/telemetry-models": "next",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",
@@ -57,7 +58,7 @@
 		"business-logic"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/auditable-item-stream/issues"
+		"url": "git+https://github.com/iotaledger/twin-auditable-item-stream/issues"
 	},
 	"homepage": "https://twindev.org"
 }