@twin.org/blob-storage-models 0.0.3-next.7 → 0.0.3-next.9

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Blob Storage Models
 
-Models which define the structure of the blob storage contracts and connectors.
+This package defines shared models, contracts, and schemas for blob identifiers, metadata, and storage operations. It provides the common language used by service, client, and connector packages so integrations remain consistent across environments.
 
 ## Installation
 

package/dist/es/models/IBlobStorageEntry.js.map

@@ -1 +1 @@
-{"version":3,"file":"IBlobStorageEntry.js","sourceRoot":"","sources":["../../../src/models/IBlobStorageEntry.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { BlobStorageCompressionType } from \"./blobStorageCompressionType.js\";\nimport type { BlobStorageContexts } from \"./blobStorageContexts.js\";\nimport type { BlobStorageTypes } from \"./blobStorageTypes.js\";\n\n/**\n * Interface describing a blob storage entry.\n */\nexport interface IBlobStorageEntry {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof BlobStorageContexts.Context,\n\t\ttypeof BlobStorageContexts.ContextCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof BlobStorageTypes.Entry;\n\n\t/**\n\t * The id for the blob.\n\t */\n\tid: string;\n\n\t/**\n\t * The date/time when the entry was created.\n\t * json-ld namespace:schema\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The date/time when the entry was modified.\n\t * json-ld namespace:schema\n\t */\n\tdateModified?: string;\n\n\t/**\n\t * The size of the data in the blob.\n\t * json-ld type:schema:Integer\n\t */\n\tblobSize: number;\n\n\t/**\n\t * The integrity of the data in the blob.\n\t * json-ld namespace:twin-common\n\t */\n\tintegrity: string;\n\n\t/**\n\t * The mime type for the blob.\n\t * json-ld namespace:schema\n\t */\n\tencodingFormat?: string;\n\n\t/**\n\t * Indicates if the blob is encrypted.\n\t * json-ld type:schema:Boolean\n\t */\n\tisEncrypted?: boolean;\n\n\t/**\n\t * The type of compression used for the blob, if not set it is not stored with compression.\n\t * json-ld type:schema:Text\n\t */\n\tcompression?: BlobStorageCompressionType;\n\n\t/**\n\t * The extension.\n\t * json-ld type:schema:Text\n\t */\n\tfileExtension?: string;\n\n\t/**\n\t * The metadata for the blob as JSON-LD.\n\t * json-ld id\n\t */\n\tmetadata?: IJsonLdNodeObject;\n\n\t/**\n\t * The blob in base64 format, included if the includeContent flag was set in the request.\n\t * json-ld type:schema:Text\n\t */\n\tblob?: string;\n}\n"]}
+{"version":3,"file":"IBlobStorageEntry.js","sourceRoot":"","sources":["../../../src/models/IBlobStorageEntry.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { BlobStorageCompressionType } from \"./blobStorageCompressionType.js\";\nimport type { BlobStorageContexts } from \"./blobStorageContexts.js\";\nimport type { BlobStorageTypes } from \"./blobStorageTypes.js\";\n\n/**\n * Interface describing a blob storage entry.\n */\nexport interface IBlobStorageEntry {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof BlobStorageContexts.Context,\n\t\ttypeof BlobStorageContexts.ContextCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof BlobStorageTypes.Entry;\n\n\t/**\n\t * The id for the blob.\n\t */\n\tid: string;\n\n\t/**\n\t * The date/time when the entry was created.\n\t * @json-ld namespace:schema\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The date/time when the entry was modified.\n\t * @json-ld namespace:schema\n\t */\n\tdateModified?: string;\n\n\t/**\n\t * The size of the data in the blob.\n\t * @json-ld type:schema:Integer\n\t */\n\tblobSize: number;\n\n\t/**\n\t * The integrity of the data in the blob.\n\t * @json-ld namespace:twin-common\n\t */\n\tintegrity: string;\n\n\t/**\n\t * The mime type for the blob.\n\t * @json-ld namespace:schema\n\t */\n\tencodingFormat?: string;\n\n\t/**\n\t * Indicates if the blob is encrypted.\n\t * @json-ld type:schema:Boolean\n\t */\n\tisEncrypted?: boolean;\n\n\t/**\n\t * The type of compression used for the blob, if not set it is not stored with compression.\n\t * @json-ld type:schema:Text\n\t */\n\tcompression?: BlobStorageCompressionType;\n\n\t/**\n\t * The extension.\n\t * @json-ld type:schema:Text\n\t */\n\tfileExtension?: string;\n\n\t/**\n\t * The metadata for the blob as JSON-LD.\n\t * @json-ld id\n\t */\n\tmetadata?: IJsonLdNodeObject;\n\n\t/**\n\t * The blob in base64 format, included if the includeContent flag was set in the request.\n\t * @json-ld type:schema:Text\n\t */\n\tblob?: string;\n}\n"]}

package/dist/es/schemas/BlobStorageCompressionType.json

@@ -1,10 +1,16 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "https://schema.twindev.org/blob-storage/BlobStorageCompressionType",
+    "title": "BlobStorageCompressionType",
     "description": "The types of compression for blob storage data.",
-    "type": "string",
-    "enum": [
-        "gzip",
-        "deflate"
+    "oneOf": [
+        {
+            "const": "gzip",
+            "description": "Gzip."
+        },
+        {
+            "const": "deflate",
+            "description": "Deflate."
+        }
     ]
 }

package/dist/es/schemas/BlobStorageEntry.json

@@ -1,29 +1,27 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "https://schema.twindev.org/blob-storage/BlobStorageEntry",
+    "title": "BlobStorageEntry",
     "description": "Interface describing a blob storage entry.",
     "type": "object",
     "properties": {
         "@context": {
             "type": "array",
-            "minItems": 2,
-            "description": "JSON-LD Context.",
             "prefixItems": [
                 {
-                    "type": "string",
                     "const": "https://schema.twindev.org/blob-storage/"
                 },
                 {
-                    "type": "string",
                     "const": "https://schema.twindev.org/common/"
                 }
             ],
             "items": {
                 "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-            }
+            },
+            "minItems": 2,
+            "description": "JSON-LD Context."
         },
         "type": {
-            "type": "string",
             "const": "BlobStorageEntry",
             "description": "JSON-LD Type."
         },
@@ -33,43 +31,43 @@
         },
         "dateCreated": {
             "type": "string",
-            "description": "The date/time when the entry was created. json-ld namespace:schema"
+            "description": "The date/time when the entry was created."
         },
         "dateModified": {
             "type": "string",
-            "description": "The date/time when the entry was modified. json-ld namespace:schema"
+            "description": "The date/time when the entry was modified."
         },
         "blobSize": {
             "type": "number",
-            "description": "The size of the data in the blob. json-ld type:schema:Integer"
+            "description": "The size of the data in the blob."
         },
         "integrity": {
             "type": "string",
-            "description": "The integrity of the data in the blob. json-ld namespace:twin-common"
+            "description": "The integrity of the data in the blob."
         },
         "encodingFormat": {
             "type": "string",
-            "description": "The mime type for the blob. json-ld namespace:schema"
+            "description": "The mime type for the blob."
         },
         "isEncrypted": {
             "type": "boolean",
-            "description": "Indicates if the blob is encrypted. json-ld type:schema:Boolean"
+            "description": "Indicates if the blob is encrypted."
         },
         "compression": {
             "$ref": "https://schema.twindev.org/blob-storage/BlobStorageCompressionType",
-            "description": "The type of compression used for the blob, if not set it is not stored with compression. json-ld type:schema:Text"
+            "description": "The type of compression used for the blob, if not set it is not stored with compression."
         },
         "fileExtension": {
             "type": "string",
-            "description": "The extension. json-ld type:schema:Text"
+            "description": "The extension."
         },
         "metadata": {
             "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-            "description": "The metadata for the blob as JSON-LD. json-ld id"
+            "description": "The metadata for the blob as JSON-LD."
         },
         "blob": {
             "type": "string",
-            "description": "The blob in base64 format, included if the includeContent flag was set in the request. json-ld type:schema:Text"
+            "description": "The blob in base64 format, included if the includeContent flag was set in the request."
         }
     },
     "required": [

package/dist/types/models/IBlobStorageEntry.d.ts

@@ -24,52 +24,52 @@ export interface IBlobStorageEntry {
     id: string;
     /**
      * The date/time when the entry was created.
-     * json-ld namespace:schema
+     * @json-ld namespace:schema
      */
     dateCreated: string;
     /**
      * The date/time when the entry was modified.
-     * json-ld namespace:schema
+     * @json-ld namespace:schema
      */
     dateModified?: string;
     /**
      * The size of the data in the blob.
-     * json-ld type:schema:Integer
+     * @json-ld type:schema:Integer
      */
     blobSize: number;
     /**
      * The integrity of the data in the blob.
-     * json-ld namespace:twin-common
+     * @json-ld namespace:twin-common
      */
     integrity: string;
     /**
      * The mime type for the blob.
-     * json-ld namespace:schema
+     * @json-ld namespace:schema
      */
     encodingFormat?: string;
     /**
      * Indicates if the blob is encrypted.
-     * json-ld type:schema:Boolean
+     * @json-ld type:schema:Boolean
      */
     isEncrypted?: boolean;
     /**
      * The type of compression used for the blob, if not set it is not stored with compression.
-     * json-ld type:schema:Text
+     * @json-ld type:schema:Text
      */
     compression?: BlobStorageCompressionType;
     /**
      * The extension.
-     * json-ld type:schema:Text
+     * @json-ld type:schema:Text
      */
     fileExtension?: string;
     /**
      * The metadata for the blob as JSON-LD.
-     * json-ld id
+     * @json-ld id
      */
     metadata?: IJsonLdNodeObject;
     /**
      * The blob in base64 format, included if the includeContent flag was set in the request.
-     * json-ld type:schema:Text
+     * @json-ld type:schema:Text
      */
     blob?: string;
 }

package/docs/changelog.md

@@ -1,190 +1,229 @@
-# @twin.org/blob-storage-models - Changelog
+# Changelog
 
-## [0.0.3-next.7](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.3-next.6...blob-storage-models-v0.0.3-next.7) (2026-02-25)
+## [0.0.3-next.9](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.3-next.8...blob-storage-models-v0.0.3-next.9) (2026-05-07)
 
 
 ### Features
 
-* update schemas ([6fe6571](https://github.com/twinfoundation/blob-storage/commit/6fe65714e23209cdd760ecd5aa8e18762044e4b3))
+* add compression support ([67d239b](https://github.com/iotaledger/twin-blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
+* add context id features ([#30](https://github.com/iotaledger/twin-blob-storage/issues/30)) ([fbf1c92](https://github.com/iotaledger/twin-blob-storage/commit/fbf1c9276424c841ef5ef3f4de8469ab3fba7e9c))
+* add missing namespace for JSON-LD context ([80b15cf](https://github.com/iotaledger/twin-blob-storage/commit/80b15cf34b580d9550affa66bcbc9b9ccb34ce21))
+* add ts-to-jsonld-context tool ([2fd217f](https://github.com/iotaledger/twin-blob-storage/commit/2fd217f50dfaf6ac068091876237f5a101a7995e))
+* add validate-locales ([f20fcec](https://github.com/iotaledger/twin-blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
+* additional encryption options on per item basis ([4b95a65](https://github.com/iotaledger/twin-blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
+* blobHash changed to integrity ([#41](https://github.com/iotaledger/twin-blob-storage/issues/41)) ([c06a55f](https://github.com/iotaledger/twin-blob-storage/commit/c06a55f0eed3f7cad5d19c4084abd8ef0cdbfb60))
+* eslint migration to flat config ([e4239dd](https://github.com/iotaledger/twin-blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
+* remove includeNodeIdentity flag ([13bc334](https://github.com/iotaledger/twin-blob-storage/commit/13bc33445b179879688af3c98e8be8a5609d3f46))
+* replace nextItem property with Link header ([#37](https://github.com/iotaledger/twin-blob-storage/issues/37)) ([0b68da5](https://github.com/iotaledger/twin-blob-storage/commit/0b68da58549c9e52eb2313ea5a868573840d5ca6))
+* update contexts ([#34](https://github.com/iotaledger/twin-blob-storage/issues/34)) ([b9e432c](https://github.com/iotaledger/twin-blob-storage/commit/b9e432c26025e4bfdf5ba837516dfdbf40f45a61))
+* update contexts and namespaces ([#32](https://github.com/iotaledger/twin-blob-storage/issues/32)) ([187ed36](https://github.com/iotaledger/twin-blob-storage/commit/187ed36a7d83062665f70689ec5e2b2f553a592e))
+* update dependencies ([56f0094](https://github.com/iotaledger/twin-blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+* update framework core ([ff339fe](https://github.com/iotaledger/twin-blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
+* update schemas ([6fe6571](https://github.com/iotaledger/twin-blob-storage/commit/6fe65714e23209cdd760ecd5aa8e18762044e4b3))
+* update to support fully qualified data type names ([3297d69](https://github.com/iotaledger/twin-blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
+* update ts-to-schema generation ([03439c7](https://github.com/iotaledger/twin-blob-storage/commit/03439c726108bf645941290e41824c57a6a23de3))
+* use shared store mechanism ([#12](https://github.com/iotaledger/twin-blob-storage/issues/12)) ([cae8110](https://github.com/iotaledger/twin-blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
+* use standard list json ld types ([d6bdfd6](https://github.com/iotaledger/twin-blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
 
-## [0.0.3-next.6](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.3-next.5...blob-storage-models-v0.0.3-next.6) (2026-02-09)
+
+### Bug Fixes
+
+* Adding the optional flag to the entity ([#10](https://github.com/iotaledger/twin-blob-storage/issues/10)) ([626677e](https://github.com/iotaledger/twin-blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
+* data validation tests ([556979a](https://github.com/iotaledger/twin-blob-storage/commit/556979a0c36a942f691c971a9bce3a5d72093f52))
+* query params force coercion ([a5e547a](https://github.com/iotaledger/twin-blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
+
+## [0.0.3-next.8](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.3-next.7...blob-storage-models-v0.0.3-next.8) (2026-05-07)
+
+
+### Bug Fixes
+
+* data validation tests ([556979a](https://github.com/iotaledger/twin-blob-storage/commit/556979a0c36a942f691c971a9bce3a5d72093f52))
+
+## [0.0.3-next.7](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.3-next.6...blob-storage-models-v0.0.3-next.7) (2026-02-25)
+
+
+### Features
+
+* update schemas ([6fe6571](https://github.com/iotaledger/twin-blob-storage/commit/6fe65714e23209cdd760ecd5aa8e18762044e4b3))
+
+## [0.0.3-next.6](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.3-next.5...blob-storage-models-v0.0.3-next.6) (2026-02-09)
 
 
 ### Features
 
-* add missing namespace for JSON-LD context ([80b15cf](https://github.com/twinfoundation/blob-storage/commit/80b15cf34b580d9550affa66bcbc9b9ccb34ce21))
-* add ts-to-jsonld-context tool ([2fd217f](https://github.com/twinfoundation/blob-storage/commit/2fd217f50dfaf6ac068091876237f5a101a7995e))
-* blobHash changed to integrity ([#41](https://github.com/twinfoundation/blob-storage/issues/41)) ([c06a55f](https://github.com/twinfoundation/blob-storage/commit/c06a55f0eed3f7cad5d19c4084abd8ef0cdbfb60))
+* add missing namespace for JSON-LD context ([80b15cf](https://github.com/iotaledger/twin-blob-storage/commit/80b15cf34b580d9550affa66bcbc9b9ccb34ce21))
+* add ts-to-jsonld-context tool ([2fd217f](https://github.com/iotaledger/twin-blob-storage/commit/2fd217f50dfaf6ac068091876237f5a101a7995e))
+* blobHash changed to integrity ([#41](https://github.com/iotaledger/twin-blob-storage/issues/41)) ([c06a55f](https://github.com/iotaledger/twin-blob-storage/commit/c06a55f0eed3f7cad5d19c4084abd8ef0cdbfb60))
 
-## [0.0.3-next.5](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.3-next.4...blob-storage-models-v0.0.3-next.5) (2026-01-26)
+## [0.0.3-next.5](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.3-next.4...blob-storage-models-v0.0.3-next.5) (2026-01-26)
 
 
 ### Miscellaneous Chores
 
 * **blob-storage-models:** Synchronize repo versions
 
-## [0.0.3-next.4](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.3-next.3...blob-storage-models-v0.0.3-next.4) (2026-01-23)
+## [0.0.3-next.4](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.3-next.3...blob-storage-models-v0.0.3-next.4) (2026-01-23)
 
 
 ### Features
 
-* replace nextItem property with Link header ([#37](https://github.com/twinfoundation/blob-storage/issues/37)) ([0b68da5](https://github.com/twinfoundation/blob-storage/commit/0b68da58549c9e52eb2313ea5a868573840d5ca6))
+* replace nextItem property with Link header ([#37](https://github.com/iotaledger/twin-blob-storage/issues/37)) ([0b68da5](https://github.com/iotaledger/twin-blob-storage/commit/0b68da58549c9e52eb2313ea5a868573840d5ca6))
 
-## [0.0.3-next.3](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.3-next.2...blob-storage-models-v0.0.3-next.3) (2026-01-21)
+## [0.0.3-next.3](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.3-next.2...blob-storage-models-v0.0.3-next.3) (2026-01-21)
 
 
 ### Features
 
-* update contexts ([#34](https://github.com/twinfoundation/blob-storage/issues/34)) ([b9e432c](https://github.com/twinfoundation/blob-storage/commit/b9e432c26025e4bfdf5ba837516dfdbf40f45a61))
+* update contexts ([#34](https://github.com/iotaledger/twin-blob-storage/issues/34)) ([b9e432c](https://github.com/iotaledger/twin-blob-storage/commit/b9e432c26025e4bfdf5ba837516dfdbf40f45a61))
 
-## [0.0.3-next.2](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.3-next.1...blob-storage-models-v0.0.3-next.2) (2026-01-14)
+## [0.0.3-next.2](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.3-next.1...blob-storage-models-v0.0.3-next.2) (2026-01-14)
 
 
 ### Features
 
-* update contexts and namespaces ([#32](https://github.com/twinfoundation/blob-storage/issues/32)) ([187ed36](https://github.com/twinfoundation/blob-storage/commit/187ed36a7d83062665f70689ec5e2b2f553a592e))
+* update contexts and namespaces ([#32](https://github.com/iotaledger/twin-blob-storage/issues/32)) ([187ed36](https://github.com/iotaledger/twin-blob-storage/commit/187ed36a7d83062665f70689ec5e2b2f553a592e))
 
-## [0.0.3-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.3-next.0...blob-storage-models-v0.0.3-next.1) (2025-11-11)
+## [0.0.3-next.1](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.3-next.0...blob-storage-models-v0.0.3-next.1) (2025-11-11)
 
 
 ### Features
 
-* add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
-* add context id features ([#30](https://github.com/twinfoundation/blob-storage/issues/30)) ([fbf1c92](https://github.com/twinfoundation/blob-storage/commit/fbf1c9276424c841ef5ef3f4de8469ab3fba7e9c))
-* add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
-* additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
-* eslint migration to flat config ([e4239dd](https://github.com/twinfoundation/blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
-* remove includeNodeIdentity flag ([13bc334](https://github.com/twinfoundation/blob-storage/commit/13bc33445b179879688af3c98e8be8a5609d3f46))
-* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
-* update framework core ([ff339fe](https://github.com/twinfoundation/blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
-* update to support fully qualified data type names ([3297d69](https://github.com/twinfoundation/blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
-* update ts-to-schema generation ([03439c7](https://github.com/twinfoundation/blob-storage/commit/03439c726108bf645941290e41824c57a6a23de3))
-* use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
-* use standard list json ld types ([d6bdfd6](https://github.com/twinfoundation/blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
+* add compression support ([67d239b](https://github.com/iotaledger/twin-blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
+* add context id features ([#30](https://github.com/iotaledger/twin-blob-storage/issues/30)) ([fbf1c92](https://github.com/iotaledger/twin-blob-storage/commit/fbf1c9276424c841ef5ef3f4de8469ab3fba7e9c))
+* add validate-locales ([f20fcec](https://github.com/iotaledger/twin-blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
+* additional encryption options on per item basis ([4b95a65](https://github.com/iotaledger/twin-blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
+* eslint migration to flat config ([e4239dd](https://github.com/iotaledger/twin-blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
+* remove includeNodeIdentity flag ([13bc334](https://github.com/iotaledger/twin-blob-storage/commit/13bc33445b179879688af3c98e8be8a5609d3f46))
+* update dependencies ([56f0094](https://github.com/iotaledger/twin-blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+* update framework core ([ff339fe](https://github.com/iotaledger/twin-blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
+* update to support fully qualified data type names ([3297d69](https://github.com/iotaledger/twin-blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
+* update ts-to-schema generation ([03439c7](https://github.com/iotaledger/twin-blob-storage/commit/03439c726108bf645941290e41824c57a6a23de3))
+* use shared store mechanism ([#12](https://github.com/iotaledger/twin-blob-storage/issues/12)) ([cae8110](https://github.com/iotaledger/twin-blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
+* use standard list json ld types ([d6bdfd6](https://github.com/iotaledger/twin-blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
 
 
 ### Bug Fixes
 
-* Adding the optional flag to the entity ([#10](https://github.com/twinfoundation/blob-storage/issues/10)) ([626677e](https://github.com/twinfoundation/blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
-* query params force coercion ([a5e547a](https://github.com/twinfoundation/blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
+* Adding the optional flag to the entity ([#10](https://github.com/iotaledger/twin-blob-storage/issues/10)) ([626677e](https://github.com/iotaledger/twin-blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
+* query params force coercion ([a5e547a](https://github.com/iotaledger/twin-blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
 
-## [0.0.2-next.5](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.2-next.4...blob-storage-models-v0.0.2-next.5) (2025-10-09)
+## [0.0.2-next.5](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.2-next.4...blob-storage-models-v0.0.2-next.5) (2025-10-09)
 
 
 ### Features
 
-* add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
+* add validate-locales ([f20fcec](https://github.com/iotaledger/twin-blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
 
-## [0.0.2-next.4](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.2-next.3...blob-storage-models-v0.0.2-next.4) (2025-10-02)
+## [0.0.2-next.4](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.2-next.3...blob-storage-models-v0.0.2-next.4) (2025-10-02)
 
 
 ### Miscellaneous Chores
 
 * **blob-storage-models:** Synchronize repo versions
 
-## [0.0.2-next.3](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.2-next.2...blob-storage-models-v0.0.2-next.3) (2025-08-29)
+## [0.0.2-next.3](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.2-next.2...blob-storage-models-v0.0.2-next.3) (2025-08-29)
 
 
 ### Features
 
-* eslint migration to flat config ([e4239dd](https://github.com/twinfoundation/blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
+* eslint migration to flat config ([e4239dd](https://github.com/iotaledger/twin-blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
 
-## [0.0.2-next.2](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.2-next.1...blob-storage-models-v0.0.2-next.2) (2025-08-20)
+## [0.0.2-next.2](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.2-next.1...blob-storage-models-v0.0.2-next.2) (2025-08-20)
 
 
 ### Features
 
-* update framework core ([ff339fe](https://github.com/twinfoundation/blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
+* update framework core ([ff339fe](https://github.com/iotaledger/twin-blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
 
-## [0.0.2-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.2-next.0...blob-storage-models-v0.0.2-next.1) (2025-07-24)
+## [0.0.2-next.1](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.2-next.0...blob-storage-models-v0.0.2-next.1) (2025-07-24)
 
 
 ### Features
 
-* add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
-* additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
-* remove includeNodeIdentity flag ([13bc334](https://github.com/twinfoundation/blob-storage/commit/13bc33445b179879688af3c98e8be8a5609d3f46))
-* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
-* update to support fully qualified data type names ([3297d69](https://github.com/twinfoundation/blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
-* update ts-to-schema generation ([03439c7](https://github.com/twinfoundation/blob-storage/commit/03439c726108bf645941290e41824c57a6a23de3))
-* use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
-* use standard list json ld types ([d6bdfd6](https://github.com/twinfoundation/blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
+* add compression support ([67d239b](https://github.com/iotaledger/twin-blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
+* additional encryption options on per item basis ([4b95a65](https://github.com/iotaledger/twin-blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
+* remove includeNodeIdentity flag ([13bc334](https://github.com/iotaledger/twin-blob-storage/commit/13bc33445b179879688af3c98e8be8a5609d3f46))
+* update dependencies ([56f0094](https://github.com/iotaledger/twin-blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+* update to support fully qualified data type names ([3297d69](https://github.com/iotaledger/twin-blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
+* update ts-to-schema generation ([03439c7](https://github.com/iotaledger/twin-blob-storage/commit/03439c726108bf645941290e41824c57a6a23de3))
+* use shared store mechanism ([#12](https://github.com/iotaledger/twin-blob-storage/issues/12)) ([cae8110](https://github.com/iotaledger/twin-blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
+* use standard list json ld types ([d6bdfd6](https://github.com/iotaledger/twin-blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
 
 
 ### Bug Fixes
 
-* Adding the optional flag to the entity ([#10](https://github.com/twinfoundation/blob-storage/issues/10)) ([626677e](https://github.com/twinfoundation/blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
-* query params force coercion ([a5e547a](https://github.com/twinfoundation/blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
+* Adding the optional flag to the entity ([#10](https://github.com/iotaledger/twin-blob-storage/issues/10)) ([626677e](https://github.com/iotaledger/twin-blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
+* query params force coercion ([a5e547a](https://github.com/iotaledger/twin-blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
 
 ## 0.0.1 (2025-07-04)
 
 
 ### Features
 
-* release to production ([eacfe75](https://github.com/twinfoundation/blob-storage/commit/eacfe754a0dcd9243d9e13d86422327d0a605164))
+* release to production ([eacfe75](https://github.com/iotaledger/twin-blob-storage/commit/eacfe754a0dcd9243d9e13d86422327d0a605164))
 
-## [0.0.1-next.37](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.36...blob-storage-models-v0.0.1-next.37) (2025-06-20)
+## [0.0.1-next.37](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.1-next.36...blob-storage-models-v0.0.1-next.37) (2025-06-20)
 
 
 ### Bug Fixes
 
-* query params force coercion ([a5e547a](https://github.com/twinfoundation/blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
+* query params force coercion ([a5e547a](https://github.com/iotaledger/twin-blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
 
-## [0.0.1-next.36](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.35...blob-storage-models-v0.0.1-next.36) (2025-06-19)
+## [0.0.1-next.36](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.1-next.35...blob-storage-models-v0.0.1-next.36) (2025-06-19)
 
 
 ### Features
 
-* add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
+* add compression support ([67d239b](https://github.com/iotaledger/twin-blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
 
-## [0.0.1-next.35](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.34...blob-storage-models-v0.0.1-next.35) (2025-06-17)
+## [0.0.1-next.35](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.1-next.34...blob-storage-models-v0.0.1-next.35) (2025-06-17)
 
 
 ### Features
 
-* additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
+* additional encryption options on per item basis ([4b95a65](https://github.com/iotaledger/twin-blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
 
-## [0.0.1-next.34](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.33...blob-storage-models-v0.0.1-next.34) (2025-06-12)
+## [0.0.1-next.34](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.1-next.33...blob-storage-models-v0.0.1-next.34) (2025-06-12)
 
 
 ### Features
 
-* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+* update dependencies ([56f0094](https://github.com/iotaledger/twin-blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
 
-## [0.0.1-next.33](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.32...blob-storage-models-v0.0.1-next.33) (2025-06-03)
+## [0.0.1-next.33](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.1-next.32...blob-storage-models-v0.0.1-next.33) (2025-06-03)
 
 
 ### Features
 
-* update ts-to-schema generation ([03439c7](https://github.com/twinfoundation/blob-storage/commit/03439c726108bf645941290e41824c57a6a23de3))
+* update ts-to-schema generation ([03439c7](https://github.com/iotaledger/twin-blob-storage/commit/03439c726108bf645941290e41824c57a6a23de3))
 
-## [0.0.1-next.32](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.31...blob-storage-models-v0.0.1-next.32) (2025-05-28)
+## [0.0.1-next.32](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.1-next.31...blob-storage-models-v0.0.1-next.32) (2025-05-28)
 
 
 ### Features
 
-* update to support fully qualified data type names ([3297d69](https://github.com/twinfoundation/blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
+* update to support fully qualified data type names ([3297d69](https://github.com/iotaledger/twin-blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
 
-## [0.0.1-next.31](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.30...blob-storage-models-v0.0.1-next.31) (2025-05-08)
+## [0.0.1-next.31](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.1-next.30...blob-storage-models-v0.0.1-next.31) (2025-05-08)
 
 
 ### Features
 
-* use standard list json ld types ([d6bdfd6](https://github.com/twinfoundation/blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
+* use standard list json ld types ([d6bdfd6](https://github.com/iotaledger/twin-blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
 
-## [0.0.1-next.30](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.29...blob-storage-models-v0.0.1-next.30) (2025-04-17)
+## [0.0.1-next.30](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.1-next.29...blob-storage-models-v0.0.1-next.30) (2025-04-17)
 
 
 ### Features
 
-* use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
+* use shared store mechanism ([#12](https://github.com/iotaledger/twin-blob-storage/issues/12)) ([cae8110](https://github.com/iotaledger/twin-blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
 
-## [0.0.1-next.29](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.28...blob-storage-models-v0.0.1-next.29) (2025-03-28)
+## [0.0.1-next.29](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.1-next.28...blob-storage-models-v0.0.1-next.29) (2025-03-28)
 
 
 ### Bug Fixes
 
-* Adding the optional flag to the entity ([#10](https://github.com/twinfoundation/blob-storage/issues/10)) ([626677e](https://github.com/twinfoundation/blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
+* Adding the optional flag to the entity ([#10](https://github.com/iotaledger/twin-blob-storage/issues/10)) ([626677e](https://github.com/iotaledger/twin-blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
 
 ## v0.0.1-next.28
 

package/docs/examples.md

@@ -1 +1,23 @@
-# @twin.org/blob-storage-models - Examples
+# Models Examples
+
+Use these snippets to register data types and resolve connector instances by namespace when composing storage workflows.
+
+## BlobStorageDataTypes
+
+```typescript
+import { BlobStorageDataTypes } from '@twin.org/blob-storage-models';
+
+BlobStorageDataTypes.registerTypes();
+```
+
+## BlobStorageConnectorFactory
+
+```typescript
+import { BlobStorageConnectorFactory } from '@twin.org/blob-storage-models';
+
+const connectorNamespaces = BlobStorageConnectorFactory.names();
+console.log(connectorNamespaces.length); // 2
+
+const defaultConnector = BlobStorageConnectorFactory.get(connectorNamespaces[0]);
+console.log(defaultConnector.className()); // MemoryBlobStorageConnector
+```

package/docs/reference/classes/BlobStorageDataTypes.md

@@ -14,7 +14,7 @@ Handle all the data types for blob storage.
 
 ## Methods
 
-### registerTypes()
+### registerTypes() {#registertypes}
 
 > `static` **registerTypes**(): `void`
 

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -8,7 +8,7 @@ Interface describing an blob storage component.
 
 ## Methods
 
-### create()
+### create() {#create}
 
 > **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `options?`): `Promise`\<`string`\>
 
@@ -76,7 +76,7 @@ The id of the stored blob in urn format.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`id`, `options?`): `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
 
@@ -124,7 +124,7 @@ Not found error if the blob cannot be found.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`): `Promise`\<`void`\>
 
@@ -168,7 +168,7 @@ Not found error if the blob cannot be found.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`id`): `Promise`\<`void`\>
 
@@ -194,7 +194,7 @@ Not found error if the blob cannot be found.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: [`IBlobStorageEntryList`](IBlobStorageEntryList.md); `cursor?`: `string`; \}\>
 
@@ -210,9 +210,9 @@ The conditions to match for the entries.
 
 ##### orderBy?
 
-The order for the results, defaults to created.
+`"dateCreated"` \| `"dateModified"`
 
-`"dateCreated"` | `"dateModified"`
+The order for the results, defaults to created.
 
 ##### orderByDirection?
 

package/docs/reference/interfaces/IBlobStorageConnector.md

@@ -8,7 +8,7 @@ Interface describing an blob storage connector.
 
 ## Methods
 
-### set()
+### set() {#set}
 
 > **set**(`blob`): `Promise`\<`string`\>
 
@@ -30,7 +30,7 @@ The id of the stored blob in urn format.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`id`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
@@ -52,7 +52,7 @@ The data for the blob if it can be found or undefined.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`id`): `Promise`\<`boolean`\>
 

package/docs/reference/interfaces/IBlobStorageCreateRequest.md

@@ -4,7 +4,7 @@ Request to create an entry in blob storage.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -18,25 +18,25 @@ The data to store in base64 encoding.
 
 #### encodingFormat?
 
-> `optional` **encodingFormat**: `string`
+> `optional` **encodingFormat?**: `string`
 
 The mime type of the blob, will be detected if left undefined.
 
 #### fileExtension?
 
-> `optional` **fileExtension**: `string`
+> `optional` **fileExtension?**: `string`
 
 The extension of the blob, will be detected if left undefined.
 
 #### metadata?
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> `optional` **metadata?**: `IJsonLdNodeObject`
 
 Custom metadata to associate with the blob as JSON-LD.
 
 #### disableEncryption?
 
-> `optional` **disableEncryption**: `boolean`
+> `optional` **disableEncryption?**: `boolean`
 
 Disables encryption if enabled by default.
 
@@ -48,13 +48,13 @@ false
 
 #### compress?
 
-> `optional` **compress**: [`BlobStorageCompressionType`](../type-aliases/BlobStorageCompressionType.md)
+> `optional` **compress?**: [`BlobStorageCompressionType`](../type-aliases/BlobStorageCompressionType.md)
 
 Optional compression type to use for the blob, defaults to no compression.
 
 #### overrideVaultKeyId?
 
-> `optional` **overrideVaultKeyId**: `string`
+> `optional` **overrideVaultKeyId?**: `string`
 
 Use a different vault key id for encryption, if not provided the default vault key id will be used.
 
@@ -66,6 +66,6 @@ undefined
 
 #### namespace?
 
-> `optional` **namespace**: `string`
+> `optional` **namespace?**: `string`
 
 The namespace to store the data in, defaults to component configured namespace.

package/docs/reference/interfaces/IBlobStorageEntry.md

@@ -4,7 +4,7 @@ Interface describing a blob storage entry.
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: \[`"https://schema.twindev.org/blob-storage/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
@@ -12,7 +12,7 @@ JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"BlobStorageEntry"`
 
@@ -20,7 +20,7 @@ JSON-LD Type.
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -28,90 +28,80 @@ The id for the blob.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
 The date/time when the entry was created.
-json-ld namespace:schema
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time when the entry was modified.
-json-ld namespace:schema
 
 ***
 
-### blobSize
+### blobSize {#blobsize}
 
 > **blobSize**: `number`
 
 The size of the data in the blob.
-json-ld type:schema:Integer
 
 ***
 
-### integrity
+### integrity {#integrity}
 
 > **integrity**: `string`
 
 The integrity of the data in the blob.
-json-ld namespace:twin-common
 
 ***
 
-### encodingFormat?
+### encodingFormat? {#encodingformat}
 
-> `optional` **encodingFormat**: `string`
+> `optional` **encodingFormat?**: `string`
 
 The mime type for the blob.
-json-ld namespace:schema
 
 ***
 
-### isEncrypted?
+### isEncrypted? {#isencrypted}
 
-> `optional` **isEncrypted**: `boolean`
+> `optional` **isEncrypted?**: `boolean`
 
 Indicates if the blob is encrypted.
-json-ld type:schema:Boolean
 
 ***
 
-### compression?
+### compression? {#compression}
 
-> `optional` **compression**: [`BlobStorageCompressionType`](../type-aliases/BlobStorageCompressionType.md)
+> `optional` **compression?**: [`BlobStorageCompressionType`](../type-aliases/BlobStorageCompressionType.md)
 
 The type of compression used for the blob, if not set it is not stored with compression.
-json-ld type:schema:Text
 
 ***
 
-### fileExtension?
+### fileExtension? {#fileextension}
 
-> `optional` **fileExtension**: `string`
+> `optional` **fileExtension?**: `string`
 
 The extension.
-json-ld type:schema:Text
 
 ***
 
-### metadata?
+### metadata? {#metadata}
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> `optional` **metadata?**: `IJsonLdNodeObject`
 
 The metadata for the blob as JSON-LD.
-json-ld id
 
 ***
 
-### blob?
+### blob? {#blob}
 
-> `optional` **blob**: `string`
+> `optional` **blob?**: `string`
 
 The blob in base64 format, included if the includeContent flag was set in the request.
-json-ld type:schema:Text

package/docs/reference/interfaces/IBlobStorageEntryList.md

@@ -4,7 +4,7 @@ Interface describing an blob storage entry list.
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/blob-storage/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
@@ -12,7 +12,7 @@ JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"ItemList"`
 
@@ -20,7 +20,7 @@ JSON-LD Type.
 
 ***
 
-### itemListElement
+### itemListElement {#itemlistelement}
 
 > **itemListElement**: [`IBlobStorageEntry`](IBlobStorageEntry.md)[]
 

package/docs/reference/interfaces/IBlobStorageGetContentRequest.md

@@ -4,7 +4,7 @@ Request to get the content from blob storage.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,15 +18,15 @@ The id of the blob to get in urn format.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### decompress?
 
-> `optional` **decompress**: `string`
+> `optional` **decompress?**: `string`
 
 If the content should be decompressed, if it was compressed when stored, defaults to true.
 
@@ -38,7 +38,7 @@ true
 
 #### overrideVaultKeyId?
 
-> `optional` **overrideVaultKeyId**: `string`
+> `optional` **overrideVaultKeyId?**: `string`
 
 Use a different vault key id for decryption, if not provided the default vault key id will be used.
 
@@ -50,7 +50,7 @@ undefined
 
 #### download?
 
-> `optional` **download**: `string`
+> `optional` **download?**: `string`
 
 Set the download flag which should prompt the browser to save the file.
 Otherwise the browser should show the content inside the page.
@@ -63,7 +63,7 @@ false
 
 #### filename?
 
-> `optional` **filename**: `string`
+> `optional` **filename?**: `string`
 
 Set the filename to use when a download is triggered.
 A filename will be generated if not provided.

package/docs/reference/interfaces/IBlobStorageGetContentResponse.md

@@ -4,7 +4,7 @@ Response to get an entry from blob storage.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `Uint8Array`
 

package/docs/reference/interfaces/IBlobStorageGetRequest.md

@@ -4,9 +4,9 @@ Request to get an entry from blob storage.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -30,15 +30,15 @@ The id of the blob to get in urn format.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### includeContent?
 
-> `optional` **includeContent**: `string`
+> `optional` **includeContent?**: `string`
 
 Include the content in the response, otherwise only metadata is returned.
 
@@ -50,7 +50,7 @@ false
 
 #### decompress?
 
-> `optional` **decompress**: `string`
+> `optional` **decompress?**: `string`
 
 If the content should be decompressed, if it was compressed when stored, defaults to true.
 
@@ -62,7 +62,7 @@ true
 
 #### overrideVaultKeyId?
 
-> `optional` **overrideVaultKeyId**: `string`
+> `optional` **overrideVaultKeyId?**: `string`
 
 Use a different vault key id for decryption, if not provided the default vault key id will be used.
 

package/docs/reference/interfaces/IBlobStorageGetResponse.md

@@ -4,9 +4,9 @@ Response to get an entry from blob storage.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IBlobStorageEntry`](IBlobStorageEntry.md)
 

package/docs/reference/interfaces/IBlobStorageListRequest.md

@@ -4,9 +4,9 @@ Query the entries from blob storage.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,38 +16,38 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The parameters from the query.
 
 #### conditions?
 
-> `optional` **conditions**: `string`
+> `optional` **conditions?**: `string`
 
 The condition for the query as JSON version of EntityCondition type.
 
 #### orderBy?
 
-> `optional` **orderBy**: `"dateCreated"` \| `"dateModified"`
+> `optional` **orderBy?**: `"dateCreated"` \| `"dateModified"`
 
 The order for the results, default to created.
 
 #### orderByDirection?
 
-> `optional` **orderByDirection**: `SortDirection`
+> `optional` **orderByDirection?**: `SortDirection`
 
 The direction for the order, defaults to desc.
 
 #### limit?
 
-> `optional` **limit**: `string`
+> `optional` **limit?**: `string`
 
 Limit the number of entities to return.
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 The cursor to get next chunk of data, returned in previous response.

package/docs/reference/interfaces/IBlobStorageListResponse.md

@@ -4,9 +4,9 @@ Response to getting the list of entries from a query.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,11 +16,11 @@ The headers which can be used to determine the response data type.
 
 #### link?
 
-> `optional` **link**: `string` \| `string`[]
+> `optional` **link?**: `string` \| `string`[]
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IBlobStorageEntryList`](IBlobStorageEntryList.md)
 

package/docs/reference/interfaces/IBlobStorageRemoveRequest.md

@@ -4,7 +4,7 @@ Request to remove an entry from blob storage.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IBlobStorageUpdateRequest.md

@@ -4,7 +4,7 @@ Request to update a blob entry.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,7 +18,7 @@ The id of the blob to get in urn format.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -26,18 +26,18 @@ The body parameters.
 
 #### encodingFormat?
 
-> `optional` **encodingFormat**: `string`
+> `optional` **encodingFormat?**: `string`
 
 The mime type of the blob, will be detected if left undefined.
 
 #### fileExtension?
 
-> `optional` **fileExtension**: `string`
+> `optional` **fileExtension?**: `string`
 
 The extension of the blob, will be detected if left undefined.
 
 #### metadata?
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> `optional` **metadata?**: `IJsonLdNodeObject`
 
 Custom metadata to associate with the blob as JSON-LD.

package/docs/reference/variables/BlobStorageCompressionType.md

@@ -6,13 +6,13 @@ The types of compression for blob storage data.
 
 ## Type Declaration
 
-### Gzip
+### Gzip {#gzip}
 
 > `readonly` **Gzip**: `"gzip"` = `"gzip"`
 
 Gzip.
 
-### Deflate
+### Deflate {#deflate}
 
 > `readonly` **Deflate**: `"deflate"` = `"deflate"`
 

package/docs/reference/variables/BlobStorageContexts.md

@@ -6,37 +6,37 @@ The contexts of blob storage data.
 
 ## Type Declaration
 
-### Namespace
+### Namespace {#namespace}
 
 > `readonly` **Namespace**: `"https://schema.twindev.org/blob-storage/"` = `"https://schema.twindev.org/blob-storage/"`
 
 The canonical RDF namespace URI for Blob Storage.
 
-### Context
+### Context {#context}
 
 > `readonly` **Context**: `"https://schema.twindev.org/blob-storage/"` = `"https://schema.twindev.org/blob-storage/"`
 
 The value to use in JSON-LD context for Blob Storage.
 
-### JsonLdContext
+### JsonLdContext {#jsonldcontext}
 
 > `readonly` **JsonLdContext**: `"https://schema.twindev.org/blob-storage/types.jsonld"` = `"https://schema.twindev.org/blob-storage/types.jsonld"`
 
 The JSON-LD Context URL.
 
-### NamespaceCommon
+### NamespaceCommon {#namespacecommon}
 
 > `readonly` **NamespaceCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
 
 The canonical RDF namespace URI for TWIN Common.
 
-### ContextCommon
+### ContextCommon {#contextcommon}
 
 > `readonly` **ContextCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
 
 The value to use in JSON-LD context for TWIN Common.
 
-### JsonLdContextCommon
+### JsonLdContextCommon {#jsonldcontextcommon}
 
 > `readonly` **JsonLdContextCommon**: `"https://schema.twindev.org/common/types.jsonld"` = `"https://schema.twindev.org/common/types.jsonld"`
 

package/docs/reference/variables/BlobStorageTypes.md

@@ -6,13 +6,13 @@ The types of blob storage data.
 
 ## Type Declaration
 
-### Entry
+### Entry {#entry}
 
 > `readonly` **Entry**: `"BlobStorageEntry"` = `"BlobStorageEntry"`
 
 Represents blob storage entry.
 
-### CompressionType
+### CompressionType {#compressiontype}
 
 > `readonly` **CompressionType**: `"BlobStorageCompressionType"` = `"BlobStorageCompressionType"`
 

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/blob-storage-models",
-	"version": "0.0.3-next.7",
-	"description": "Models which define the structure of the blob storage contracts and connectors",
+	"version": "0.0.3-next.9",
+	"description": "Defines shared contracts, schemas, and interfaces for blob content, metadata, and connector behaviour.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/blob-storage.git",
+		"url": "git+https://github.com/iotaledger/blob-storage.git",
 		"directory": "packages/blob-storage-models"
 	},
 	"author": "martyn.janes@iota.org",
@@ -54,7 +54,7 @@
 		"schemas"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/blob-storage/issues"
+		"url": "git+https://github.com/iotaledger/blob-storage/issues"
 	},
 	"homepage": "https://twindev.org"
 }