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

package/dist/cjs/index.cjs

@@ -492,7 +492,7 @@ async function blobStorageUpdate(httpRequestContext, componentName, request) {
     core.Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     core.Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
     const component = core.ComponentFactory.get(componentName);
-    await component.update(request.pathParams.id, request.body.encodingFormat, request.body.fileExtension, request.body.metadata, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    await component.update(request.pathParams.id, request.body.encodingFormat, request.body.fileExtension, request.body.metadata, httpRequestContext.userIdentity);
     return {
         statusCode: web.HttpStatusCode.noContent
     };
@@ -509,7 +509,7 @@ async function blobStorageRemove(httpRequestContext, componentName, request) {
     core.Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     core.Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
     const component = core.ComponentFactory.get(componentName);
-    await component.remove(request.pathParams.id, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    await component.remove(request.pathParams.id, httpRequestContext.userIdentity);
     return {
         statusCode: web.HttpStatusCode.noContent
     };
@@ -525,7 +525,7 @@ async function blobStorageList(httpRequestContext, componentName, request) {
     core.Guards.object(ROUTES_SOURCE, "request", request);
     const mimeType = request.headers?.[web.HeaderTypes.Accept] === web.MimeTypes.JsonLd ? "jsonld" : "json";
     const component = core.ComponentFactory.get(componentName);
-    const result = await component.query(apiModels.HttpParameterHelper.objectFromString(request.query?.conditions), request.query?.orderBy, request.query?.orderByDirection, request.query?.cursor, core.Coerce.number(request.query?.pageSize), httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    const result = await component.query(apiModels.HttpParameterHelper.objectFromString(request.query?.conditions), request.query?.orderBy, request.query?.orderByDirection, request.query?.cursor, core.Coerce.number(request.query?.pageSize), httpRequestContext.userIdentity);
     return {
         headers: {
             [web.HeaderTypes.ContentType]: mimeType === "json" ? web.MimeTypes.Json : web.MimeTypes.JsonLd
@@ -542,8 +542,9 @@ async function blobStorageList(httpRequestContext, componentName, request) {
 class BlobStorageService {
     /**
      * The namespace supported by the blob storage service.
+     * @internal
      */
-    static NAMESPACE = "blob";
+    static _NAMESPACE = "blob";
     /**
      * Runtime name for the class.
      */
@@ -570,15 +571,10 @@ class BlobStorageService {
      */
     _vaultKeyId;
     /**
-     * Include the node identity when performing storage operations, defaults to true.
-     * @internal
-     */
-    _includeNodeIdentity;
-    /**
-     * Include the user identity when performing storage operations, defaults to true.
+     * Include the user identity when performing storage operations, can be used to partition for users, defaults to false.
      * @internal
      */
-    _includeUserIdentity;
+    _partitionPerUser;
     /**
      * Create a new instance of BlobStorageService.
      * @param options The options for the service.
@@ -594,8 +590,7 @@ class BlobStorageService {
         }
         this._defaultNamespace = options?.config?.defaultNamespace ?? names[0];
         this._vaultKeyId = options?.config?.vaultKeyId;
-        this._includeNodeIdentity = options?.config?.includeNodeIdentity ?? true;
-        this._includeUserIdentity = options?.config?.includeUserIdentity ?? true;
+        this._partitionPerUser = options?.config?.partitionPerUser ?? false;
         standardsSchemaOrg.SchemaOrgDataTypes.registerRedirects();
     }
     /**
@@ -615,15 +610,12 @@ class BlobStorageService {
      */
     async create(blob, encodingFormat, fileExtension, metadata, options, userIdentity, nodeIdentity) {
         core.Guards.stringBase64(this.CLASS_NAME, "blob", blob);
-        if (this._includeUserIdentity) {
+        if (this._partitionPerUser) {
             core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
         }
         const disableEncryption = options?.disableEncryption ?? false;
         const vaultKeyId = options?.overrideVaultKeyId ?? this._vaultKeyId;
         const encryptionEnabled = !disableEncryption && core.Is.stringValue(vaultKeyId);
-        if (this._includeNodeIdentity || encryptionEnabled) {
-            core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-        }
         try {
             const connectorNamespace = options?.namespace ?? this._defaultNamespace;
             const blobStorageConnector = blobStorageModels.BlobStorageConnectorFactory.get(connectorNamespace);
@@ -650,6 +642,7 @@ class BlobStorageService {
             }
             // If we have a vault connector then encrypt the data.
             if (encryptionEnabled) {
+                core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
                 if (core.Is.empty(this._vaultConnector)) {
                     throw new core.GeneralError(this.CLASS_NAME, "vaultConnectorNotConfigured");
                 }
@@ -670,14 +663,10 @@ class BlobStorageService {
                 compression: options?.compress
             };
             const conditions = [];
-            if (this._includeUserIdentity) {
+            if (this._partitionPerUser) {
                 core.ObjectHelper.propertySet(blobEntry, "userIdentity", userIdentity);
                 conditions.push({ property: "userIdentity", value: userIdentity });
             }
-            if (this._includeNodeIdentity) {
-                core.ObjectHelper.propertySet(blobEntry, "nodeIdentity", nodeIdentity);
-                conditions.push({ property: "nodeIdentity", value: nodeIdentity });
-            }
             await this._entryEntityStorage.set(blobEntry, conditions);
             return blobId;
         }
@@ -702,7 +691,7 @@ class BlobStorageService {
         const includeContent = options?.includeContent ?? false;
         const vaultKeyId = options?.overrideVaultKeyId ?? this._vaultKeyId;
         const conditions = [];
-        if (this._includeUserIdentity) {
+        if (this._partitionPerUser) {
             core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
             conditions.push({
                 property: "userIdentity",
@@ -710,16 +699,8 @@ class BlobStorageService {
                 value: userIdentity
             });
         }
-        if (this._includeNodeIdentity || (core.Is.notEmpty(this._vaultConnector) && includeContent)) {
-            core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-            conditions.push({
-                property: "nodeIdentity",
-                comparison: entity.ComparisonOperator.Equals,
-                value: nodeIdentity
-            });
-        }
         try {
-            const blobEntry = await this.internalGet(id, userIdentity, nodeIdentity);
+            const blobEntry = await this.internalGet(id, userIdentity);
             let returnBlob;
             if (includeContent) {
                 const blobStorageConnector = this.getConnector(id);
@@ -730,6 +711,7 @@ class BlobStorageService {
                 // If the data is encrypted then decrypt it.
                 const decryptionEnabled = blobEntry.isEncrypted && core.Is.stringValue(vaultKeyId);
                 if (decryptionEnabled) {
+                    core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
                     if (core.Is.empty(this._vaultConnector)) {
                         throw new core.GeneralError(this.CLASS_NAME, "vaultConnectorNotConfigured");
                     }
@@ -753,18 +735,14 @@ class BlobStorageService {
      * @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.
-     * @param nodeIdentity The node identity to use with storage operations.
      * @returns Nothing.
      * @throws Not found error if the blob cannot be found.
      */
-    async update(id, encodingFormat, fileExtension, metadata, userIdentity, nodeIdentity) {
+    async update(id, encodingFormat, fileExtension, metadata, userIdentity) {
         core.Urn.guard(this.CLASS_NAME, "id", id);
-        if (this._includeUserIdentity) {
+        if (this._partitionPerUser) {
             core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
         }
-        if (this._includeNodeIdentity || core.Is.notEmpty(this._vaultConnector)) {
-            core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-        }
         try {
             const blobEntry = await this._entryEntityStorage.get(id);
             if (core.Is.undefined(blobEntry)) {
@@ -789,14 +767,10 @@ class BlobStorageService {
                 compression: blobEntry.compression
             };
             const conditions = [];
-            if (this._includeUserIdentity) {
+            if (this._partitionPerUser) {
                 core.ObjectHelper.propertySet(updatedBlobEntry, "userIdentity", userIdentity);
                 conditions.push({ property: "userIdentity", value: userIdentity });
             }
-            if (this._includeNodeIdentity) {
-                core.ObjectHelper.propertySet(updatedBlobEntry, "nodeIdentity", nodeIdentity);
-                conditions.push({ property: "nodeIdentity", value: nodeIdentity });
-            }
             await this._entryEntityStorage.set(updatedBlobEntry, conditions);
         }
         catch (error) {
@@ -807,26 +781,19 @@ class BlobStorageService {
      * 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.
-     * @param nodeIdentity The node identity to use with storage operations.
      * @returns Nothing.
      */
-    async remove(id, userIdentity, nodeIdentity) {
+    async remove(id, userIdentity) {
         core.Urn.guard(this.CLASS_NAME, "id", id);
-        if (this._includeUserIdentity) {
+        if (this._partitionPerUser) {
             core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
         }
-        if (this._includeNodeIdentity || core.Is.notEmpty(this._vaultConnector)) {
-            core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-        }
         try {
             const blobStorageConnector = this.getConnector(id);
             const conditions = [];
-            if (this._includeUserIdentity) {
+            if (this._partitionPerUser) {
                 conditions.push({ property: "userIdentity", value: userIdentity });
             }
-            if (this._includeNodeIdentity) {
-                conditions.push({ property: "nodeIdentity", value: nodeIdentity });
-            }
             await this._entryEntityStorage.remove(id, conditions);
             const removed = await blobStorageConnector.remove(id);
             if (!removed) {
@@ -845,24 +812,15 @@ class BlobStorageService {
      * @param cursor The cursor to request the next page of entries.
      * @param pageSize 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.
-     * @param nodeIdentity The node 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.
      */
-    async query(conditions, orderBy, orderByDirection, cursor, pageSize, userIdentity, nodeIdentity) {
+    async query(conditions, orderBy, orderByDirection, cursor, pageSize, userIdentity) {
         const finalConditions = {
             conditions: [],
             logicalOperator: entity.LogicalOperator.And
         };
-        if (this._includeNodeIdentity) {
-            core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-            finalConditions.conditions.push({
-                property: "nodeIdentity",
-                comparison: entity.ComparisonOperator.Equals,
-                value: nodeIdentity
-            });
-        }
-        if (this._includeUserIdentity) {
+        if (this._partitionPerUser) {
             core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
             finalConditions.conditions.push({
                 property: "userIdentity",
@@ -908,9 +866,9 @@ class BlobStorageService {
      */
     getConnector(id) {
         const idUri = core.Urn.fromValidString(id);
-        if (idUri.namespaceIdentifier() !== BlobStorageService.NAMESPACE) {
+        if (idUri.namespaceIdentifier() !== BlobStorageService._NAMESPACE) {
             throw new core.GeneralError(this.CLASS_NAME, "namespaceMismatch", {
-                namespace: BlobStorageService.NAMESPACE,
+                namespace: BlobStorageService._NAMESPACE,
                 id
             });
         }
@@ -921,13 +879,12 @@ class BlobStorageService {
      * @param id The id of the entity to get, or the index value if secondaryIndex is set.
      * @param secondaryIndex Get the item using a secondary index.
      * @param userIdentity The user identity to use with storage operations.
-     * @param nodeIdentity The node identity to use with storage operations.
      * @returns The object if it can be found or throws.
      * @internal
      */
-    async internalGet(id, userIdentity, nodeIdentity) {
+    async internalGet(id, userIdentity) {
         const conditions = [];
-        if (this._includeUserIdentity) {
+        if (this._partitionPerUser) {
             core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
             conditions.push({
                 property: "userIdentity",
@@ -935,14 +892,6 @@ class BlobStorageService {
                 value: userIdentity
             });
         }
-        if (this._includeNodeIdentity) {
-            core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-            conditions.push({
-                property: "nodeIdentity",
-                comparison: entity.ComparisonOperator.Equals,
-                value: nodeIdentity
-            });
-        }
         let entity$1;
         if (conditions.length === 0) {
             entity$1 = await this._entryEntityStorage.get(id);
@@ -964,7 +913,7 @@ class BlobStorageService {
         if (core.Is.empty(entity$1)) {
             throw new core.NotFoundError(this.CLASS_NAME, "entityNotFound", id);
         }
-        return core.ObjectHelper.omit(entity$1, ["nodeIdentity", "userIdentity"]);
+        return core.ObjectHelper.omit(entity$1, ["userIdentity"]);
     }
     /**
      * Convert the entry to JSON-LD.
@@ -1045,10 +994,6 @@ exports.BlobStorageEntry = class BlobStorageEntry {
      * The user identity that created the blob.
      */
     userIdentity;
-    /**
-     * The node identity that created the blob.
-     */
-    nodeIdentity;
 };
 __decorate([
     entity.property({ type: "string", isPrimary: true }),
@@ -1099,10 +1044,6 @@ __decorate([
     entity.property({ type: "string", optional: true }),
     __metadata("design:type", String)
 ], exports.BlobStorageEntry.prototype, "userIdentity", void 0);
-__decorate([
-    entity.property({ type: "string", optional: true }),
-    __metadata("design:type", String)
-], exports.BlobStorageEntry.prototype, "nodeIdentity", void 0);
 exports.BlobStorageEntry = __decorate([
     entity.entity()
 ], exports.BlobStorageEntry);

package/dist/esm/index.mjs

@@ -490,7 +490,7 @@ async function blobStorageUpdate(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
     const component = ComponentFactory.get(componentName);
-    await component.update(request.pathParams.id, request.body.encodingFormat, request.body.fileExtension, request.body.metadata, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    await component.update(request.pathParams.id, request.body.encodingFormat, request.body.fileExtension, request.body.metadata, httpRequestContext.userIdentity);
     return {
         statusCode: HttpStatusCode.noContent
     };
@@ -507,7 +507,7 @@ async function blobStorageRemove(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
     const component = ComponentFactory.get(componentName);
-    await component.remove(request.pathParams.id, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    await component.remove(request.pathParams.id, httpRequestContext.userIdentity);
     return {
         statusCode: HttpStatusCode.noContent
     };
@@ -523,7 +523,7 @@ async function blobStorageList(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request", request);
     const mimeType = request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? "jsonld" : "json";
     const component = ComponentFactory.get(componentName);
-    const result = await component.query(HttpParameterHelper.objectFromString(request.query?.conditions), request.query?.orderBy, request.query?.orderByDirection, request.query?.cursor, Coerce.number(request.query?.pageSize), httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    const result = await component.query(HttpParameterHelper.objectFromString(request.query?.conditions), request.query?.orderBy, request.query?.orderByDirection, request.query?.cursor, Coerce.number(request.query?.pageSize), httpRequestContext.userIdentity);
     return {
         headers: {
             [HeaderTypes.ContentType]: mimeType === "json" ? MimeTypes.Json : MimeTypes.JsonLd
@@ -540,8 +540,9 @@ async function blobStorageList(httpRequestContext, componentName, request) {
 class BlobStorageService {
     /**
      * The namespace supported by the blob storage service.
+     * @internal
      */
-    static NAMESPACE = "blob";
+    static _NAMESPACE = "blob";
     /**
      * Runtime name for the class.
      */
@@ -568,15 +569,10 @@ class BlobStorageService {
      */
     _vaultKeyId;
     /**
-     * Include the node identity when performing storage operations, defaults to true.
-     * @internal
-     */
-    _includeNodeIdentity;
-    /**
-     * Include the user identity when performing storage operations, defaults to true.
+     * Include the user identity when performing storage operations, can be used to partition for users, defaults to false.
      * @internal
      */
-    _includeUserIdentity;
+    _partitionPerUser;
     /**
      * Create a new instance of BlobStorageService.
      * @param options The options for the service.
@@ -592,8 +588,7 @@ class BlobStorageService {
         }
         this._defaultNamespace = options?.config?.defaultNamespace ?? names[0];
         this._vaultKeyId = options?.config?.vaultKeyId;
-        this._includeNodeIdentity = options?.config?.includeNodeIdentity ?? true;
-        this._includeUserIdentity = options?.config?.includeUserIdentity ?? true;
+        this._partitionPerUser = options?.config?.partitionPerUser ?? false;
         SchemaOrgDataTypes.registerRedirects();
     }
     /**
@@ -613,15 +608,12 @@ class BlobStorageService {
      */
     async create(blob, encodingFormat, fileExtension, metadata, options, userIdentity, nodeIdentity) {
         Guards.stringBase64(this.CLASS_NAME, "blob", blob);
-        if (this._includeUserIdentity) {
+        if (this._partitionPerUser) {
             Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
         }
         const disableEncryption = options?.disableEncryption ?? false;
         const vaultKeyId = options?.overrideVaultKeyId ?? this._vaultKeyId;
         const encryptionEnabled = !disableEncryption && Is.stringValue(vaultKeyId);
-        if (this._includeNodeIdentity || encryptionEnabled) {
-            Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-        }
         try {
             const connectorNamespace = options?.namespace ?? this._defaultNamespace;
             const blobStorageConnector = BlobStorageConnectorFactory.get(connectorNamespace);
@@ -648,6 +640,7 @@ class BlobStorageService {
             }
             // If we have a vault connector then encrypt the data.
             if (encryptionEnabled) {
+                Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
                 if (Is.empty(this._vaultConnector)) {
                     throw new GeneralError(this.CLASS_NAME, "vaultConnectorNotConfigured");
                 }
@@ -668,14 +661,10 @@ class BlobStorageService {
                 compression: options?.compress
             };
             const conditions = [];
-            if (this._includeUserIdentity) {
+            if (this._partitionPerUser) {
                 ObjectHelper.propertySet(blobEntry, "userIdentity", userIdentity);
                 conditions.push({ property: "userIdentity", value: userIdentity });
             }
-            if (this._includeNodeIdentity) {
-                ObjectHelper.propertySet(blobEntry, "nodeIdentity", nodeIdentity);
-                conditions.push({ property: "nodeIdentity", value: nodeIdentity });
-            }
             await this._entryEntityStorage.set(blobEntry, conditions);
             return blobId;
         }
@@ -700,7 +689,7 @@ class BlobStorageService {
         const includeContent = options?.includeContent ?? false;
         const vaultKeyId = options?.overrideVaultKeyId ?? this._vaultKeyId;
         const conditions = [];
-        if (this._includeUserIdentity) {
+        if (this._partitionPerUser) {
             Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
             conditions.push({
                 property: "userIdentity",
@@ -708,16 +697,8 @@ class BlobStorageService {
                 value: userIdentity
             });
         }
-        if (this._includeNodeIdentity || (Is.notEmpty(this._vaultConnector) && includeContent)) {
-            Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-            conditions.push({
-                property: "nodeIdentity",
-                comparison: ComparisonOperator.Equals,
-                value: nodeIdentity
-            });
-        }
         try {
-            const blobEntry = await this.internalGet(id, userIdentity, nodeIdentity);
+            const blobEntry = await this.internalGet(id, userIdentity);
             let returnBlob;
             if (includeContent) {
                 const blobStorageConnector = this.getConnector(id);
@@ -728,6 +709,7 @@ class BlobStorageService {
                 // If the data is encrypted then decrypt it.
                 const decryptionEnabled = blobEntry.isEncrypted && Is.stringValue(vaultKeyId);
                 if (decryptionEnabled) {
+                    Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
                     if (Is.empty(this._vaultConnector)) {
                         throw new GeneralError(this.CLASS_NAME, "vaultConnectorNotConfigured");
                     }
@@ -751,18 +733,14 @@ class BlobStorageService {
      * @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.
-     * @param nodeIdentity The node identity to use with storage operations.
      * @returns Nothing.
      * @throws Not found error if the blob cannot be found.
      */
-    async update(id, encodingFormat, fileExtension, metadata, userIdentity, nodeIdentity) {
+    async update(id, encodingFormat, fileExtension, metadata, userIdentity) {
         Urn.guard(this.CLASS_NAME, "id", id);
-        if (this._includeUserIdentity) {
+        if (this._partitionPerUser) {
             Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
         }
-        if (this._includeNodeIdentity || Is.notEmpty(this._vaultConnector)) {
-            Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-        }
         try {
             const blobEntry = await this._entryEntityStorage.get(id);
             if (Is.undefined(blobEntry)) {
@@ -787,14 +765,10 @@ class BlobStorageService {
                 compression: blobEntry.compression
             };
             const conditions = [];
-            if (this._includeUserIdentity) {
+            if (this._partitionPerUser) {
                 ObjectHelper.propertySet(updatedBlobEntry, "userIdentity", userIdentity);
                 conditions.push({ property: "userIdentity", value: userIdentity });
             }
-            if (this._includeNodeIdentity) {
-                ObjectHelper.propertySet(updatedBlobEntry, "nodeIdentity", nodeIdentity);
-                conditions.push({ property: "nodeIdentity", value: nodeIdentity });
-            }
             await this._entryEntityStorage.set(updatedBlobEntry, conditions);
         }
         catch (error) {
@@ -805,26 +779,19 @@ class BlobStorageService {
      * 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.
-     * @param nodeIdentity The node identity to use with storage operations.
      * @returns Nothing.
      */
-    async remove(id, userIdentity, nodeIdentity) {
+    async remove(id, userIdentity) {
         Urn.guard(this.CLASS_NAME, "id", id);
-        if (this._includeUserIdentity) {
+        if (this._partitionPerUser) {
             Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
         }
-        if (this._includeNodeIdentity || Is.notEmpty(this._vaultConnector)) {
-            Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-        }
         try {
             const blobStorageConnector = this.getConnector(id);
             const conditions = [];
-            if (this._includeUserIdentity) {
+            if (this._partitionPerUser) {
                 conditions.push({ property: "userIdentity", value: userIdentity });
             }
-            if (this._includeNodeIdentity) {
-                conditions.push({ property: "nodeIdentity", value: nodeIdentity });
-            }
             await this._entryEntityStorage.remove(id, conditions);
             const removed = await blobStorageConnector.remove(id);
             if (!removed) {
@@ -843,24 +810,15 @@ class BlobStorageService {
      * @param cursor The cursor to request the next page of entries.
      * @param pageSize 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.
-     * @param nodeIdentity The node 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.
      */
-    async query(conditions, orderBy, orderByDirection, cursor, pageSize, userIdentity, nodeIdentity) {
+    async query(conditions, orderBy, orderByDirection, cursor, pageSize, userIdentity) {
         const finalConditions = {
             conditions: [],
             logicalOperator: LogicalOperator.And
         };
-        if (this._includeNodeIdentity) {
-            Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-            finalConditions.conditions.push({
-                property: "nodeIdentity",
-                comparison: ComparisonOperator.Equals,
-                value: nodeIdentity
-            });
-        }
-        if (this._includeUserIdentity) {
+        if (this._partitionPerUser) {
             Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
             finalConditions.conditions.push({
                 property: "userIdentity",
@@ -906,9 +864,9 @@ class BlobStorageService {
      */
     getConnector(id) {
         const idUri = Urn.fromValidString(id);
-        if (idUri.namespaceIdentifier() !== BlobStorageService.NAMESPACE) {
+        if (idUri.namespaceIdentifier() !== BlobStorageService._NAMESPACE) {
             throw new GeneralError(this.CLASS_NAME, "namespaceMismatch", {
-                namespace: BlobStorageService.NAMESPACE,
+                namespace: BlobStorageService._NAMESPACE,
                 id
             });
         }
@@ -919,13 +877,12 @@ class BlobStorageService {
      * @param id The id of the entity to get, or the index value if secondaryIndex is set.
      * @param secondaryIndex Get the item using a secondary index.
      * @param userIdentity The user identity to use with storage operations.
-     * @param nodeIdentity The node identity to use with storage operations.
      * @returns The object if it can be found or throws.
      * @internal
      */
-    async internalGet(id, userIdentity, nodeIdentity) {
+    async internalGet(id, userIdentity) {
         const conditions = [];
-        if (this._includeUserIdentity) {
+        if (this._partitionPerUser) {
             Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
             conditions.push({
                 property: "userIdentity",
@@ -933,14 +890,6 @@ class BlobStorageService {
                 value: userIdentity
             });
         }
-        if (this._includeNodeIdentity) {
-            Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-            conditions.push({
-                property: "nodeIdentity",
-                comparison: ComparisonOperator.Equals,
-                value: nodeIdentity
-            });
-        }
         let entity;
         if (conditions.length === 0) {
             entity = await this._entryEntityStorage.get(id);
@@ -962,7 +911,7 @@ class BlobStorageService {
         if (Is.empty(entity)) {
             throw new NotFoundError(this.CLASS_NAME, "entityNotFound", id);
         }
-        return ObjectHelper.omit(entity, ["nodeIdentity", "userIdentity"]);
+        return ObjectHelper.omit(entity, ["userIdentity"]);
     }
     /**
      * Convert the entry to JSON-LD.
@@ -1043,10 +992,6 @@ let BlobStorageEntry = class BlobStorageEntry {
      * The user identity that created the blob.
      */
     userIdentity;
-    /**
-     * The node identity that created the blob.
-     */
-    nodeIdentity;
 };
 __decorate([
     property({ type: "string", isPrimary: true }),
@@ -1097,10 +1042,6 @@ __decorate([
     property({ type: "string", optional: true }),
     __metadata("design:type", String)
 ], BlobStorageEntry.prototype, "userIdentity", void 0);
-__decorate([
-    property({ type: "string", optional: true }),
-    __metadata("design:type", String)
-], BlobStorageEntry.prototype, "nodeIdentity", void 0);
 BlobStorageEntry = __decorate([
     entity()
 ], BlobStorageEntry);

package/dist/types/blobStorageService.d.ts

@@ -6,10 +6,6 @@ import type { IBlobStorageServiceConstructorOptions } from "./models/IBlobStorag
  * Service for performing blob storage operations to a connector.
  */
 export declare class BlobStorageService implements IBlobStorageComponent {
-    /**
-     * The namespace supported by the blob storage service.
-     */
-    static readonly NAMESPACE: string;
     /**
      * Runtime name for the class.
      */
@@ -64,19 +60,17 @@ export declare class BlobStorageService implements IBlobStorageComponent {
      * @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.
-     * @param nodeIdentity The node 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, nodeIdentity?: string): Promise<void>;
+    update(id: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, userIdentity?: string): 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.
-     * @param nodeIdentity The node identity to use with storage operations.
      * @returns Nothing.
      */
-    remove(id: string, userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    remove(id: string, userIdentity?: string): Promise<void>;
     /**
      * Query all the blob storage entries which match the conditions.
      * @param conditions The conditions to match for the entries.
@@ -85,9 +79,8 @@ export declare class BlobStorageService implements IBlobStorageComponent {
      * @param cursor The cursor to request the next page of entries.
      * @param pageSize 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.
-     * @param nodeIdentity The node 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, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IBlobStorageEntryList>;
+    query(conditions?: EntityCondition<IBlobStorageEntry>, orderBy?: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, cursor?: string, pageSize?: number, userIdentity?: string): Promise<IBlobStorageEntryList>;
 }

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

@@ -48,8 +48,4 @@ export declare class BlobStorageEntry {
      * The user identity that created the blob.
      */
     userIdentity?: string;
-    /**
-     * The node identity that created the blob.
-     */
-    nodeIdentity?: string;
 }

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

@@ -12,11 +12,7 @@ export interface IBlobStorageServiceConfig {
      */
     defaultNamespace?: string;
     /**
-     * Include the node identity when performing storage operations, defaults to true.
+     * Include the user identity when performing storage operations, allow partitioning per user, defaults to false.
      */
-    includeNodeIdentity?: boolean;
-    /**
-     * Include the user identity when performing storage operations, defaults to true.
-     */
-    includeUserIdentity?: boolean;
+    partitionPerUser?: boolean;
 }

package/docs/changelog.md

@@ -1,5 +1,34 @@
 # @twin.org/blob-storage-service - Changelog
 
+## [0.0.2-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.2-next.0...blob-storage-service-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))
+* remove unused namespace ([6376433](https://github.com/twinfoundation/blob-storage/commit/637643399ffa42dbf6af07e7579e82e392ac90c9))
+* 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))
+* 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.2-next.0 to 0.0.2-next.1
+  * devDependencies
+    * @twin.org/blob-storage-connector-memory bumped from 0.0.2-next.0 to 0.0.2-next.1
+
 ## 0.0.1 (2025-07-04)
 
 

package/docs/open-api/spec.json

@@ -1,5 +1,5 @@
 {
-	"openapi": "3.1.0",
+	"openapi": "3.1.1",
 	"info": {
 		"title": "TWIN - Test Endpoints",
 		"description": "REST API for TWIN - Test Endpoints.",
@@ -986,6 +986,9 @@
 					"@context": {
 						"type": "array",
 						"minItems": 2,
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						},
 						"description": "JSON-LD Context.",
 						"prefixItems": [
 							{
@@ -996,10 +999,7 @@
 								"type": "string",
 								"const": "https://schema.twindev.org/common/"
 							}
-						],
-						"items": {
-							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-						}
+						]
 					},
 					"type": {
 						"type": "string",
@@ -1066,6 +1066,9 @@
 					"@context": {
 						"type": "array",
 						"minItems": 3,
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						},
 						"description": "JSON-LD Context.",
 						"prefixItems": [
 							{
@@ -1080,10 +1083,7 @@
 								"type": "string",
 								"const": "https://schema.twindev.org/common/"
 							}
-						],
-						"items": {
-							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-						}
+						]
 					},
 					"type": {
 						"type": "string",
@@ -1092,6 +1092,7 @@
 					},
 					"itemListElement": {
 						"type": "array",
+						"items": false,
 						"description": "The list of entries.",
 						"prefixItems": [
 							{

package/docs/reference/classes/BlobStorageEntry.md

@@ -99,11 +99,3 @@ Is the entry compressed.
 > `optional` **userIdentity**: `string`
 
 The user identity that created the blob.
-
-***
-
-### nodeIdentity?
-
-> `optional` **nodeIdentity**: `string`
-
-The node identity that created the blob.

package/docs/reference/classes/BlobStorageService.md

@@ -28,14 +28,6 @@ The options for the service.
 
 ## Properties
 
-### NAMESPACE
-
-> `readonly` `static` **NAMESPACE**: `string` = `"blob"`
-
-The namespace supported by the blob storage service.
-
-***
-
 ### CLASS\_NAME
 
 > `readonly` **CLASS\_NAME**: `string`
@@ -198,7 +190,7 @@ Not found error if the blob cannot be found.
 
 ### update()
 
-> **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
+> **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`, `userIdentity?`): `Promise`\<`void`\>
 
 Update the blob with metadata.
 
@@ -234,12 +226,6 @@ Data for the custom metadata as JSON-LD.
 
 The user identity to use with storage operations.
 
-##### nodeIdentity?
-
-`string`
-
-The node identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -258,7 +244,7 @@ Not found error if the blob cannot be found.
 
 ### remove()
 
-> **remove**(`id`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
+> **remove**(`id`, `userIdentity?`): `Promise`\<`void`\>
 
 Remove the blob.
 
@@ -276,12 +262,6 @@ The id of the blob to remove in urn format.
 
 The user identity to use with storage operations.
 
-##### nodeIdentity?
-
-`string`
-
-The node identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -296,7 +276,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IBlobStorageEntryList`\>
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `pageSize?`, `userIdentity?`): `Promise`\<`IBlobStorageEntryList`\>
 
 Query all the blob storage entries which match the conditions.
 
@@ -338,12 +318,6 @@ The suggested number of entries to return in each chunk, in some scenarios can r
 
 The user identity to use with storage operations.
 
-##### nodeIdentity?
-
-`string`
-
-The node identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<`IBlobStorageEntryList`\>

package/docs/reference/interfaces/IBlobStorageServiceConfig.md

@@ -21,16 +21,8 @@ Defaults to the first entry in the factory if not provided.
 
 ***
 
-### includeNodeIdentity?
+### partitionPerUser?
 
-> `optional` **includeNodeIdentity**: `boolean`
+> `optional` **partitionPerUser**: `boolean`
 
-Include the node identity when performing storage operations, defaults to true.
-
-***
-
-### includeUserIdentity?
-
-> `optional` **includeUserIdentity**: `boolean`
-
-Include the user identity when performing storage operations, defaults to true.
+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.1",
+	"version": "0.0.2-next.1",
 	"description": "Blob storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -14,17 +14,17 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "^0.0.1",
-		"@twin.org/blob-storage-models": "^0.0.1",
-		"@twin.org/core": "^0.0.1",
-		"@twin.org/crypto": "^0.0.1",
-		"@twin.org/data-json-ld": "^0.0.1",
-		"@twin.org/entity": "^0.0.1",
-		"@twin.org/entity-storage-models": "^0.0.1",
-		"@twin.org/nameof": "^0.0.1",
-		"@twin.org/standards-schema-org": "^0.0.1",
-		"@twin.org/vault-models": "^0.0.1",
-		"@twin.org/web": "^0.0.1"
+		"@twin.org/api-models": "next",
+		"@twin.org/blob-storage-models": "0.0.2-next.1",
+		"@twin.org/core": "next",
+		"@twin.org/crypto": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-models": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-schema-org": "next",
+		"@twin.org/vault-models": "next",
+		"@twin.org/web": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",