@twin.org/blob-storage-service 0.0.1-next.8 → 0.0.1

package/docs/reference/interfaces/IBlobStorageServiceConfig.md

@@ -8,13 +8,7 @@ Configuration for the blob storage service.
 
 > `optional` **vaultKeyId**: `string`
 
-The name of the vault key to use for encryption if the service has a vault connector configured.
-
-#### Default
-
-```ts
-blob-storage.
-```
+The name of the vault key to use for encryption, if not configured no encryption will happen.
 
 ***
 
@@ -24,3 +18,19 @@ blob-storage.
 
 The namespace of the default storage connector to use.
 Defaults to the first entry in the factory if not provided.
+
+***
+
+### includeNodeIdentity?
+
+> `optional` **includeNodeIdentity**: `boolean`
+
+Include the node identity when performing storage operations, defaults to true.
+
+***
+
+### includeUserIdentity?
+
+> `optional` **includeUserIdentity**: `boolean`
+
+Include the user identity when performing storage operations, defaults to true.

package/docs/reference/interfaces/IBlobStorageServiceConstructorOptions.md

@@ -0,0 +1,33 @@
+# Interface: IBlobStorageServiceConstructorOptions
+
+Options for the Blob Storage Service constructor.
+
+## Properties
+
+### entryEntityStorageType?
+
+> `optional` **entryEntityStorageType**: `string`
+
+The type of the storage connector for the metadata.
+
+#### Default
+
+```ts
+blob-storage-entry
+```
+
+***
+
+### vaultConnectorType?
+
+> `optional` **vaultConnectorType**: `string`
+
+The type of the vault connector for encryption.
+
+***
+
+### config?
+
+> `optional` **config**: [`IBlobStorageServiceConfig`](IBlobStorageServiceConfig.md)
+
+The configuration for the service.

package/docs/reference/variables/restEntryPoints.md

@@ -1,3 +1,7 @@
 # Variable: restEntryPoints
 
 > `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+These are dummy entry points for the blob storage service.
+In reality your application would create its own entry points based on the
+blob types it wants to store, using a custom defaultBaseRoute.

package/locales/en.json

@@ -6,7 +6,8 @@
 			"getFailed": "There was a problem getting the blob",
 			"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}\""
+			"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."
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-service",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1",
 	"description": "Blob storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -14,26 +14,28 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "next",
-		"@twin.org/blob-storage-models": "0.0.1-next.8",
-		"@twin.org/core": "next",
-		"@twin.org/data-json-ld": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/vault-models": "next",
-		"@twin.org/web": "next"
+		"@twin.org/api-models": "^0.0.1",
+		"@twin.org/blob-storage-models": "^0.0.1",
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/crypto": "^0.0.1",
+		"@twin.org/data-json-ld": "^0.0.1",
+		"@twin.org/entity": "^0.0.1",
+		"@twin.org/entity-storage-models": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1",
+		"@twin.org/standards-schema-org": "^0.0.1",
+		"@twin.org/vault-models": "^0.0.1",
+		"@twin.org/web": "^0.0.1"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",

package/dist/types/entities/blobMetadata.d.ts

@@ -1,22 +0,0 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-/**
- * Class representing metadata for the blob storage.
- */
-export declare class BlobMetadata {
-    /**
-     * The id for the blob.
-     */
-    id: string;
-    /**
-     * The mime type for the blob.
-     */
-    mimeType?: string;
-    /**
-     * The extension.
-     */
-    extension?: string;
-    /**
-     * The metadata for the blob as JSON-LD.
-     */
-    metadata?: IJsonLdNodeObject;
-}

package/docs/reference/classes/BlobMetadata.md

@@ -1,45 +0,0 @@
-# Class: BlobMetadata
-
-Class representing metadata for the blob storage.
-
-## Constructors
-
-### new BlobMetadata()
-
-> **new BlobMetadata**(): [`BlobMetadata`](BlobMetadata.md)
-
-#### Returns
-
-[`BlobMetadata`](BlobMetadata.md)
-
-## Properties
-
-### id
-
-> **id**: `string`
-
-The id for the blob.
-
-***
-
-### mimeType?
-
-> `optional` **mimeType**: `string`
-
-The mime type for the blob.
-
-***
-
-### extension?
-
-> `optional` **extension**: `string`
-
-The extension.
-
-***
-
-### metadata?
-
-> `optional` **metadata**: `IJsonLdNodeObject`
-
-The metadata for the blob as JSON-LD.