@twin.org/blob-storage-service 0.0.2-next.4 → 0.0.3-next.1

package/docs/reference/classes/BlobStorageService.md

@@ -30,19 +30,33 @@ The options for the service.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IBlobStorageComponent.CLASS_NAME`
+`IBlobStorageComponent.className`
 
-## Methods
+***
 
 ### create()
 
-> **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
+> **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `options?`): `Promise`\<`string`\>
 
 Create the blob with some metadata.
 
@@ -92,7 +106,7 @@ Use a different vault key id for encryption, if not provided the default vault k
 
 `BlobStorageCompressionType`
 
-Optional compression type to use for the blob, defaults to no compression.*
+Optional compression type to use for the blob, defaults to no compression.
 
 ###### namespace?
 
@@ -100,18 +114,6 @@ Optional compression type to use for the blob, defaults to no compression.*
 
 The namespace to use for storing, defaults to component configured namespace.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<`string`\>
@@ -126,7 +128,7 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IBlobStorageEntry`\>
+> **get**(`id`, `options?`): `Promise`\<`IBlobStorageEntry`\>
 
 Get the blob entry.
 
@@ -160,18 +162,6 @@ If the content should be decompressed, if it was compressed when stored, default
 
 Use a different vault key id for decryption, if not provided the default vault key id will be used.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<`IBlobStorageEntry`\>
@@ -190,7 +180,7 @@ Not found error if the blob cannot be found.
 
 ### update()
 
-> **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`, `userIdentity?`): `Promise`\<`void`\>
+> **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`): `Promise`\<`void`\>
 
 Update the blob with metadata.
 
@@ -220,12 +210,6 @@ Extension for the blob, will be detected if left undefined.
 
 Data for the custom metadata as JSON-LD.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -244,7 +228,7 @@ Not found error if the blob cannot be found.
 
 ### remove()
 
-> **remove**(`id`, `userIdentity?`): `Promise`\<`void`\>
+> **remove**(`id`): `Promise`\<`void`\>
 
 Remove the blob.
 
@@ -256,12 +240,6 @@ Remove the blob.
 
 The id of the blob to remove in urn format.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -276,7 +254,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `pageSize?`, `userIdentity?`): `Promise`\<`IBlobStorageEntryList`\>
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `limit?`): `Promise`\<`IBlobStorageEntryList`\>
 
 Query all the blob storage entries which match the conditions.
 
@@ -306,18 +284,12 @@ The direction for the order, defaults to descending.
 
 The cursor to request the next page of entries.
 
-##### pageSize?
+##### limit?
 
 `number`
 
 The suggested number of entries to return in each chunk, in some scenarios can return a different amount.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<`IBlobStorageEntryList`\>

package/docs/reference/interfaces/IBlobStorageServiceConfig.md

@@ -18,11 +18,3 @@ The name of the vault key to use for encryption, if not configured no encryption
 
 The namespace of the default storage connector to use.
 Defaults to the first entry in the factory if not provided.
-
-***
-
-### partitionPerUser?
-
-> `optional` **partitionPerUser**: `boolean`
-
-Include the user identity when performing storage operations, allow partitioning per user, defaults to false.

package/locales/en.json

@@ -7,7 +7,9 @@
 			"updateFailed": "There was a problem updating the blob",
 			"removeFailed": "There was a problem removing the blob",
 			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the blob storage service \"{namespace}\"",
-			"vaultConnectorNotConfigured": "The vault connector is not configured, but encryption/decryption was requested."
+			"vaultConnectorNotConfigured": "The vault connector is not configured, but encryption/decryption was requested.",
+			"blobNotFound": "The blob with id \"{notFoundId}\" was not found",
+			"entityNotFound": "The entity with id \"{notFoundId}\" was not found"
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-service",
-	"version": "0.0.2-next.4",
+	"version": "0.0.3-next.1",
 	"description": "Blob storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -15,7 +15,8 @@
 	},
 	"dependencies": {
 		"@twin.org/api-models": "next",
-		"@twin.org/blob-storage-models": "0.0.2-next.4",
+		"@twin.org/blob-storage-models": "0.0.3-next.1",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/data-json-ld": "next",
@@ -26,20 +27,18 @@
 		"@twin.org/vault-models": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
@@ -58,5 +57,9 @@
 		"service",
 		"microservice",
 		"business-logic"
-	]
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/blob-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }