@twin.org/blob-storage-models 0.0.2-next.5 → 0.0.3-next.10

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

@@ -1,7 +1,7 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { BlobStorageCompressionType } from "./blobStorageCompressionType";
-import type { BlobStorageContexts } from "./blobStorageContexts";
-import type { BlobStorageTypes } from "./blobStorageTypes";
+import type { BlobStorageCompressionType } from "./blobStorageCompressionType.js";
+import type { BlobStorageContexts } from "./blobStorageContexts.js";
+import type { BlobStorageTypes } from "./blobStorageTypes.js";
 /**
  * Interface describing a blob storage entry.
  */
@@ -10,8 +10,8 @@ export interface IBlobStorageEntry {
      * JSON-LD Context.
      */
     "@context": [
-        typeof BlobStorageContexts.ContextRoot,
-        typeof BlobStorageContexts.ContextRootCommon,
+        typeof BlobStorageContexts.Context,
+        typeof BlobStorageContexts.ContextCommon,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**
@@ -24,42 +24,52 @@ export interface IBlobStorageEntry {
     id: string;
     /**
      * The date/time when the entry was created.
+     * @json-ld namespace:schema
      */
     dateCreated: string;
     /**
      * The date/time when the entry was modified.
+     * @json-ld namespace:schema
      */
     dateModified?: string;
     /**
      * The size of the data in the blob.
+     * @json-ld type:schema:Integer
      */
     blobSize: number;
     /**
-     * The hash of the data in the blob.
+     * The integrity of the data in the blob.
+     * @json-ld namespace:twin-common
      */
-    blobHash: string;
+    integrity: string;
     /**
      * The mime type for the blob.
+     * @json-ld namespace:schema
      */
     encodingFormat?: string;
     /**
      * Indicates if the blob is encrypted.
+     * @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
      */
     compression?: BlobStorageCompressionType;
     /**
      * The extension.
+     * @json-ld type:schema:Text
      */
     fileExtension?: string;
     /**
      * The metadata for the blob as JSON-LD.
+     * @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
      */
     blob?: string;
 }

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

@@ -1,7 +1,7 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
 import type { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
-import type { BlobStorageContexts } from "./blobStorageContexts";
-import type { IBlobStorageEntry } from "./IBlobStorageEntry";
+import type { BlobStorageContexts } from "./blobStorageContexts.js";
+import type { IBlobStorageEntry } from "./IBlobStorageEntry.js";
 /**
  * Interface describing an blob storage entry list.
  */
@@ -10,9 +10,9 @@ export interface IBlobStorageEntryList {
      * JSON-LD Context.
      */
     "@context": [
-        typeof SchemaOrgContexts.ContextRoot,
-        typeof BlobStorageContexts.ContextRoot,
-        typeof BlobStorageContexts.ContextRootCommon,
+        typeof SchemaOrgContexts.Context,
+        typeof BlobStorageContexts.Context,
+        typeof BlobStorageContexts.ContextCommon,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**
@@ -23,8 +23,4 @@ export interface IBlobStorageEntryList {
      * The list of entries.
      */
     [SchemaOrgTypes.ItemListElement]: IBlobStorageEntry[];
-    /**
-     * The cursor to get the next chunk of entries.
-     */
-    [SchemaOrgTypes.NextItem]?: string;
 }

package/dist/types/models/api/IBlobStorageCreateRequest.d.ts

@@ -1,5 +1,5 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { BlobStorageCompressionType } from "../blobStorageCompressionType";
+import type { BlobStorageCompressionType } from "../blobStorageCompressionType.js";
 /**
  * Request to create an entry in blob storage.
  */

package/dist/types/models/api/IBlobStorageGetContentRequest.d.ts

@@ -19,7 +19,7 @@ export interface IBlobStorageGetContentRequest {
          * If the content should be decompressed, if it was compressed when stored, defaults to true.
          * @default true
          */
-        decompress?: boolean | string;
+        decompress?: string;
         /**
          * Use a different vault key id for decryption, if not provided the default vault key id will be used.
          * @default undefined
@@ -30,7 +30,7 @@ export interface IBlobStorageGetContentRequest {
          * Otherwise the browser should show the content inside the page.
          * @default false
          */
-        download?: boolean | string;
+        download?: string;
         /**
          * Set the filename to use when a download is triggered.
          * A filename will be generated if not provided.

package/dist/types/models/api/IBlobStorageGetRequest.d.ts

@@ -26,12 +26,12 @@ export interface IBlobStorageGetRequest {
          * Include the content in the response, otherwise only metadata is returned.
          * @default false
          */
-        includeContent?: boolean | string;
+        includeContent?: string;
         /**
          * If the content should be decompressed, if it was compressed when stored, defaults to true.
          * @default true
          */
-        decompress?: boolean | string;
+        decompress?: string;
         /**
          * Use a different vault key id for decryption, if not provided the default vault key id will be used.
          * @default undefined

package/dist/types/models/api/IBlobStorageGetResponse.d.ts

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IBlobStorageEntry } from "../IBlobStorageEntry";
+import type { IBlobStorageEntry } from "../IBlobStorageEntry.js";
 /**
  * Response to get an entry from blob storage.
  */

package/dist/types/models/api/IBlobStorageListRequest.d.ts

@@ -1,6 +1,6 @@
 import type { SortDirection } from "@twin.org/entity";
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IBlobStorageEntry } from "../IBlobStorageEntry";
+import type { IBlobStorageEntry } from "../IBlobStorageEntry.js";
 /**
  * Query the entries from blob storage.
  */

package/dist/types/models/api/IBlobStorageListResponse.d.ts

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IBlobStorageEntryList } from "../IBlobStorageEntryList";
+import type { IBlobStorageEntryList } from "../IBlobStorageEntryList.js";
 /**
  * Response to getting the list of entries from a query.
  */
@@ -9,6 +9,7 @@ export interface IBlobStorageListResponse {
      */
     headers?: {
         [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+        [HeaderTypes.Link]?: string | string[];
     };
     /**
      * The list of entries from the query.

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

@@ -3,13 +3,29 @@
  */
 export declare const BlobStorageContexts: {
     /**
-     * The context root for the blob storage types.
+     * The canonical RDF namespace URI for Blob Storage.
      */
-    readonly ContextRoot: "https://schema.twindev.org/blob-storage/";
+    readonly Namespace: "https://schema.twindev.org/blob-storage/";
     /**
-     * The context root for the common types.
+     * The value to use in JSON-LD context for Blob Storage.
      */
-    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+    readonly Context: "https://schema.twindev.org/blob-storage/";
+    /**
+     * The JSON-LD Context URL.
+     */
+    readonly JsonLdContext: "https://schema.twindev.org/blob-storage/types.jsonld";
+    /**
+     * The canonical RDF namespace URI for TWIN Common.
+     */
+    readonly NamespaceCommon: "https://schema.twindev.org/common/";
+    /**
+     * The value to use in JSON-LD context for TWIN Common.
+     */
+    readonly ContextCommon: "https://schema.twindev.org/common/";
+    /**
+     * The JSON-LD Context URL for TWIN Common.
+     */
+    readonly JsonLdContextCommon: "https://schema.twindev.org/common/types.jsonld";
 };
 /**
  * The contexts of blob storage data.

package/docs/changelog.md

@@ -1,122 +1,236 @@
-# @twin.org/blob-storage-models - Changelog
+# Changelog
 
-## [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.3-next.10](https://github.com/iotaledger/twin-blob-storage/compare/blob-storage-models-v0.0.3-next.9...blob-storage-models-v0.0.3-next.10) (2026-05-07)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-models:** Synchronize repo versions
+
+## [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
+
+* 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))
+
+
+### 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/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/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/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/iotaledger/twin-blob-storage/issues/37)) ([0b68da5](https://github.com/iotaledger/twin-blob-storage/commit/0b68da58549c9e52eb2313ea5a868573840d5ca6))
+
+## [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/iotaledger/twin-blob-storage/issues/34)) ([b9e432c](https://github.com/iotaledger/twin-blob-storage/commit/b9e432c26025e4bfdf5ba837516dfdbf40f45a61))
+
+## [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/iotaledger/twin-blob-storage/issues/32)) ([187ed36](https://github.com/iotaledger/twin-blob-storage/commit/187ed36a7d83062665f70689ec5e2b2f553a592e))
+
+## [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/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/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/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`