@twin.org/blob-storage-service 0.0.2-next.5 → 0.0.3-next.2

package/dist/types/blobStorageService.d.ts

@@ -1,7 +1,7 @@
 import { type BlobStorageCompressionType, type IBlobStorageComponent, type IBlobStorageEntry, type IBlobStorageEntryList } from "@twin.org/blob-storage-models";
 import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { SortDirection, type EntityCondition } from "@twin.org/entity";
-import type { IBlobStorageServiceConstructorOptions } from "./models/IBlobStorageServiceConstructorOptions";
+import type { IBlobStorageServiceConstructorOptions } from "./models/IBlobStorageServiceConstructorOptions.js";
 /**
  * Service for performing blob storage operations to a connector.
  */
@@ -15,6 +15,11 @@ export declare class BlobStorageService implements IBlobStorageComponent {
      * @param options The options for the service.
      */
     constructor(options?: IBlobStorageServiceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Create the blob with some metadata.
      * @param blob The data for the blob in base64 format.
@@ -24,10 +29,8 @@ export declare class BlobStorageService implements IBlobStorageComponent {
      * @param options Optional options for the creation of the blob.
      * @param options.disableEncryption Disables encryption if enabled by default.
      * @param options.overrideVaultKeyId Use a different vault key id for encryption, if not provided the default vault key id will be used.
-     * @param options.compress Optional compression type to use for the blob, defaults to no compression.*
+     * @param options.compress Optional compression type to use for the blob, defaults to no compression.
      * @param options.namespace The namespace to use for storing, defaults to component configured namespace.
-     * @param userIdentity The user identity to use with storage operations.
-     * @param nodeIdentity The node identity to use with storage operations.
      * @returns The id of the stored blob in urn format.
      */
     create(blob: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, options?: {
@@ -35,7 +38,7 @@ export declare class BlobStorageService implements IBlobStorageComponent {
         overrideVaultKeyId?: string;
         compress?: BlobStorageCompressionType;
         namespace?: string;
-    }, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    }): Promise<string>;
     /**
      * Get the blob entry.
      * @param id The id of the blob to get in urn format.
@@ -43,8 +46,6 @@ export declare class BlobStorageService implements IBlobStorageComponent {
      * @param options.includeContent Include the content, or just get the metadata.
      * @param options.overrideVaultKeyId Use a different vault key id for decryption, if not provided the default vault key id will be used.
      * @param options.decompress If the content should be decompressed, if it was compressed when stored, defaults to true.
-     * @param userIdentity The user identity to use with storage operations.
-     * @param nodeIdentity The node identity to use with storage operations.
      * @returns The entry and data for the blob if it can be found.
      * @throws Not found error if the blob cannot be found.
      */
@@ -52,25 +53,23 @@ export declare class BlobStorageService implements IBlobStorageComponent {
         includeContent?: boolean;
         decompress?: boolean;
         overrideVaultKeyId?: string;
-    }, userIdentity?: string, nodeIdentity?: string): Promise<IBlobStorageEntry>;
+    }): Promise<IBlobStorageEntry>;
     /**
      * Update the blob with metadata.
      * @param id The id of the blob entry to update.
      * @param encodingFormat Mime type for the blob, will be detected if left undefined.
      * @param fileExtension Extension for the blob, will be detected if left undefined.
      * @param metadata Data for the custom metadata as JSON-LD.
-     * @param userIdentity The user identity to use with storage operations.
      * @returns Nothing.
      * @throws Not found error if the blob cannot be found.
      */
-    update(id: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, userIdentity?: string): Promise<void>;
+    update(id: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject): Promise<void>;
     /**
      * Remove the blob.
      * @param id The id of the blob to remove in urn format.
-     * @param userIdentity The user identity to use with storage operations.
      * @returns Nothing.
      */
-    remove(id: string, userIdentity?: string): Promise<void>;
+    remove(id: string): Promise<void>;
     /**
      * Query all the blob storage entries which match the conditions.
      * @param conditions The conditions to match for the entries.
@@ -78,9 +77,8 @@ export declare class BlobStorageService implements IBlobStorageComponent {
      * @param orderByDirection The direction for the order, defaults to descending.
      * @param cursor The cursor to request the next page of entries.
      * @param limit The suggested number of entries to return in each chunk, in some scenarios can return a different amount.
-     * @param userIdentity The user identity to use with storage operations.
      * @returns All the entries for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    query(conditions?: EntityCondition<IBlobStorageEntry>, orderBy?: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, cursor?: string, limit?: number, userIdentity?: string): Promise<IBlobStorageEntryList>;
+    query(conditions?: EntityCondition<IBlobStorageEntry>, orderBy?: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, cursor?: string, limit?: number): Promise<IBlobStorageEntryList>;
 }

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

@@ -44,8 +44,4 @@ export declare class BlobStorageEntry {
      * Is the entry compressed.
      */
     compression?: BlobStorageCompressionType;
-    /**
-     * The user identity that created the blob.
-     */
-    userIdentity?: string;
 }

package/dist/types/index.d.ts

@@ -1,7 +1,7 @@
-export * from "./blobStorageRoutes";
-export * from "./blobStorageService";
-export * from "./entities/blobStorageEntry";
-export * from "./models/IBlobStorageServiceConfig";
-export * from "./models/IBlobStorageServiceConstructorOptions";
-export * from "./restEntryPoints";
-export * from "./schema";
+export * from "./blobStorageRoutes.js";
+export * from "./blobStorageService.js";
+export * from "./entities/blobStorageEntry.js";
+export * from "./models/IBlobStorageServiceConfig.js";
+export * from "./models/IBlobStorageServiceConstructorOptions.js";
+export * from "./restEntryPoints.js";
+export * from "./schema.js";

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

@@ -11,8 +11,4 @@ export interface IBlobStorageServiceConfig {
      * Defaults to the first entry in the factory if not provided.
      */
     defaultNamespace?: string;
-    /**
-     * Include the user identity when performing storage operations, allow partitioning per user, defaults to false.
-     */
-    partitionPerUser?: boolean;
 }

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

@@ -1,4 +1,4 @@
-import type { IBlobStorageServiceConfig } from "./IBlobStorageServiceConfig";
+import type { IBlobStorageServiceConfig } from "./IBlobStorageServiceConfig.js";
 /**
  * Options for the Blob Storage Service constructor.
  */

package/docs/changelog.md

@@ -1,5 +1,59 @@
 # @twin.org/blob-storage-service - Changelog
 
+## [0.0.3-next.2](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.3-next.1...blob-storage-service-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))
+
+
+### Bug Fixes
+
+* api docs ([0f5d3ad](https://github.com/twinfoundation/blob-storage/commit/0f5d3ad88c4c048495ffd64886d00ceb25a976d6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.3-next.1 to 0.0.3-next.2
+  * devDependencies
+    * @twin.org/blob-storage-connector-memory bumped from 0.0.3-next.1 to 0.0.3-next.2
+
+## [0.0.3-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.3-next.0...blob-storage-service-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))
+* remove unused namespace ([6376433](https://github.com/twinfoundation/blob-storage/commit/637643399ffa42dbf6af07e7579e82e392ac90c9))
+* 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))
+* 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))
+
+
+### 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))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+  * devDependencies
+    * @twin.org/blob-storage-connector-memory bumped from 0.0.3-next.0 to 0.0.3-next.1
+
 ## [0.0.2-next.5](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.2-next.4...blob-storage-service-v0.0.2-next.5) (2025-10-09)
 
 

package/docs/open-api/spec.json

@@ -388,10 +388,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"boolean",
-								"string"
-							]
+							"type": "string"
 						},
 						"example": "true"
 					},
@@ -401,10 +398,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"boolean",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -983,9 +977,6 @@
 					"@context": {
 						"type": "array",
 						"minItems": 2,
-						"items": {
-							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-						},
 						"description": "JSON-LD Context.",
 						"prefixItems": [
 							{
@@ -996,7 +987,10 @@
 								"type": "string",
 								"const": "https://schema.twindev.org/common/"
 							}
-						]
+						],
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						}
 					},
 					"type": {
 						"type": "string",
@@ -1063,9 +1057,6 @@
 					"@context": {
 						"type": "array",
 						"minItems": 3,
-						"items": {
-							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-						},
 						"description": "JSON-LD Context.",
 						"prefixItems": [
 							{
@@ -1080,7 +1071,10 @@
 								"type": "string",
 								"const": "https://schema.twindev.org/common/"
 							}
-						]
+						],
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						}
 					},
 					"type": {
 						"type": "string",
@@ -1089,13 +1083,10 @@
 					},
 					"itemListElement": {
 						"type": "array",
-						"items": false,
-						"description": "The list of entries.",
-						"prefixItems": [
-							{
-								"$ref": "#/components/schemas/BlobStorageEntry"
-							}
-						]
+						"items": {
+							"$ref": "#/components/schemas/BlobStorageEntry"
+						},
+						"description": "The list of entries."
 					},
 					"nextItem": {
 						"type": "string",

package/docs/reference/classes/BlobStorageEntry.md

@@ -91,11 +91,3 @@ Is the entry encrypted.
 > `optional` **compression**: `BlobStorageCompressionType`
 
 Is the entry compressed.
-
-***
-
-### userIdentity?
-
-> `optional` **userIdentity**: `string`
-
-The user identity that created the blob.

package/docs/reference/classes/BlobStorageService.md

@@ -36,9 +36,27 @@ 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.className`
+
+***
+
 ### 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.
 
@@ -88,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?
 
@@ -96,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`\>
@@ -122,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.
 
@@ -156,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`\>
@@ -186,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.
 
@@ -216,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`\>
@@ -240,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.
 
@@ -252,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`\>
@@ -272,7 +254,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `limit?`, `userIdentity?`): `Promise`\<`IBlobStorageEntryList`\>
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `limit?`): `Promise`\<`IBlobStorageEntryList`\>
 
 Query all the blob storage entries which match the conditions.
 
@@ -308,12 +290,6 @@ The cursor to request the next page of entries.
 
 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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-service",
-	"version": "0.0.2-next.5",
+	"version": "0.0.3-next.2",
 	"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.5",
+		"@twin.org/blob-storage-models": "0.0.3-next.2",
+		"@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"