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

package/dist/cjs/index.cjs

@@ -4,9 +4,9 @@ var core = require('@twin.org/core');
 var web = require('@twin.org/web');
 var blobStorageModels = require('@twin.org/blob-storage-models');
 var dataJsonLd = require('@twin.org/data-json-ld');
+var entity = require('@twin.org/entity');
 var entityStorageModels = require('@twin.org/entity-storage-models');
 var vaultModels = require('@twin.org/vault-models');
-var entity = require('@twin.org/entity');
 
 /**
  * The source used when communicating about these routes.
@@ -25,13 +25,19 @@ const tagsBlobStorage = [
  * The REST routes for blob storage.
  * @param baseRouteName Prefix to prepend to the paths.
  * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param options Additional options for the routes.
+ * @param options.typeName Optional type name to use in the routes, defaults to Blob Storage.
+ * @param options.tagName Optional name to use in OpenAPI spec for tag.
  * @returns The generated routes.
  */
-function generateRestRoutesBlobStorage(baseRouteName, componentName) {
+function generateRestRoutesBlobStorage(baseRouteName, componentName, options) {
+    const typeName = options?.typeName ?? "Blob Storage";
+    const lowerName = typeName.toLowerCase();
+    const camelTypeName = core.StringHelper.camelCase(typeName);
     const blobStorageCreateRoute = {
-        operationId: "blobStorageCreate",
-        summary: "Create a blob in to storage",
-        tag: tagsBlobStorage[0].name,
+        operationId: `${camelTypeName}Create`,
+        summary: `Create an entry in ${lowerName}`,
+        tag: options?.tagName ?? tagsBlobStorage[0].name,
         method: "POST",
         path: `${baseRouteName}/`,
         handler: async (httpRequestContext, request) => blobStorageCreate(httpRequestContext, componentName, request),
@@ -39,7 +45,7 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName) {
             type: "IBlobStorageCreateRequest",
             examples: [
                 {
-                    id: "blobStorageCreateExample",
+                    id: `${camelTypeName}CreateRequestExample`,
                     request: {
                         body: {
                             blob: "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZw==",
@@ -58,7 +64,7 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName) {
                 type: "ICreatedResponse",
                 examples: [
                     {
-                        id: "blobStorageCreateResponseExample",
+                        id: `${camelTypeName}CreateResponseExample`,
                         response: {
                             statusCode: web.HttpStatusCode.created,
                             headers: {
@@ -71,9 +77,9 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName) {
         ]
     };
     const blobStorageGetRoute = {
-        operationId: "blobStorageGet",
-        summary: "Get the blob metadata from storage",
-        tag: tagsBlobStorage[0].name,
+        operationId: `${camelTypeName}Get`,
+        summary: `Get the metadata for an item from ${lowerName}`,
+        tag: options?.tagName ?? tagsBlobStorage[0].name,
         method: "GET",
         path: `${baseRouteName}/:id`,
         handler: async (httpRequestContext, request) => blobStorageGet(httpRequestContext, componentName, request),
@@ -81,7 +87,7 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName) {
             type: "IBlobStorageGetRequest",
             examples: [
                 {
-                    id: "blobStorageGetRequestExample",
+                    id: `${camelTypeName}GetRequestExample`,
                     request: {
                         pathParams: {
                             id: "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70"
@@ -98,7 +104,7 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName) {
                 type: "IBlobStorageGetResponse",
                 examples: [
                     {
-                        id: "blobStorageGetResponseExample",
+                        id: `${camelTypeName}GetResponseExample`,
                         response: {
                             body: {
                                 metadata: {
@@ -118,9 +124,9 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName) {
         ]
     };
     const blobStorageGetContentRoute = {
-        operationId: "blobStorageGetContent",
-        summary: "Get the blob from storage",
-        tag: tagsBlobStorage[0].name,
+        operationId: `${camelTypeName}GetContent`,
+        summary: `Get the content for an item in ${lowerName}`,
+        tag: options?.tagName ?? tagsBlobStorage[0].name,
         method: "GET",
         path: `${baseRouteName}/:id/content`,
         handler: async (httpRequestContext, request) => blobStorageGetContent(httpRequestContext, componentName, request),
@@ -128,7 +134,7 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName) {
             type: "IBlobStorageGetRequest",
             examples: [
                 {
-                    id: "blobStorageGetContentRequestExample",
+                    id: `${camelTypeName}GetContentRequestExample`,
                     request: {
                         pathParams: {
                             id: "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70"
@@ -147,7 +153,7 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName) {
                 mimeType: web.MimeTypes.OctetStream,
                 examples: [
                     {
-                        id: "blobStorageGetContentResponseExample",
+                        id: `${camelTypeName}GetContentResponseExample`,
                         description: `The content of the blob, which will be a specific mime type if one can be detected from the content (or set as mimeType in the metadata), or defaults to ${web.MimeTypes.OctetStream}.`,
                         response: {
                             body: new Uint8Array()
@@ -161,9 +167,9 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName) {
         ]
     };
     const blobStorageUpdateRoute = {
-        operationId: "blobStorageUpdate",
-        summary: "Update a blob metadata in storage",
-        tag: tagsBlobStorage[0].name,
+        operationId: `${camelTypeName}Update`,
+        summary: `Update the metadata for an item in ${lowerName}`,
+        tag: options?.tagName ?? tagsBlobStorage[0].name,
         method: "PUT",
         path: `${baseRouteName}/:id`,
         handler: async (httpRequestContext, request) => blobStorageUpdate(httpRequestContext, componentName, request),
@@ -171,7 +177,7 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName) {
             type: "IBlobStorageUpdateRequest",
             examples: [
                 {
-                    id: "blobStorageUpdateExample",
+                    id: `${camelTypeName}UpdateRequestExample`,
                     request: {
                         pathParams: {
                             id: "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70"
@@ -194,9 +200,9 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName) {
         ]
     };
     const blobStorageRemoveRoute = {
-        operationId: "blobStorageRemove",
-        summary: "Remove the blob from storage",
-        tag: tagsBlobStorage[0].name,
+        operationId: `${camelTypeName}Remove`,
+        summary: `Remove an item from ${lowerName}`,
+        tag: options?.tagName ?? tagsBlobStorage[0].name,
         method: "DELETE",
         path: `${baseRouteName}/:id`,
         handler: async (httpRequestContext, request) => blobStorageRemove(httpRequestContext, componentName, request),
@@ -204,7 +210,7 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName) {
             type: "IBlobStorageRemoveRequest",
             examples: [
                 {
-                    id: "blobStorageRemoveRequestExample",
+                    id: `${camelTypeName}RemoveRequestExample`,
                     request: {
                         pathParams: {
                             id: "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70"
@@ -262,7 +268,7 @@ async function blobStorageGet(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);
-    const result = await component.get(request.pathParams.id, request.query?.includeContent ?? false, httpRequestContext.nodeIdentity);
+    const result = await component.get(request.pathParams.id, request.query?.includeContent ?? false, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         body: result
     };
@@ -279,7 +285,7 @@ async function blobStorageGetContent(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);
-    const result = await component.get(request.pathParams.id, true, httpRequestContext.nodeIdentity);
+    const result = await component.get(request.pathParams.id, true, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     const mimeType = result?.mimeType ?? web.MimeTypes.OctetStream;
     let filename = request.query?.filename;
     if (!core.Is.stringValue(filename)) {
@@ -306,7 +312,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.mimeType, request.body.extension, request.body.metadata);
+    await component.update(request.pathParams.id, request.body.mimeType, request.body.extension, request.body.metadata, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         statusCode: web.HttpStatusCode.noContent
     };
@@ -323,7 +329,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);
+    await component.remove(request.pathParams.id, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         statusCode: web.HttpStatusCode.noContent
     };
@@ -364,6 +370,16 @@ class BlobStorageService {
      * @internal
      */
     _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.
+     * @internal
+     */
+    _includeUserIdentity;
     /**
      * Create a new instance of BlobStorageService.
      * @param options The dependencies for the service.
@@ -382,6 +398,8 @@ class BlobStorageService {
         }
         this._defaultNamespace = options?.config?.defaultNamespace ?? names[0];
         this._vaultKeyId = options?.config?.vaultKeyId ?? "blob-storage";
+        this._includeNodeIdentity = options?.config?.includeNodeIdentity ?? true;
+        this._includeUserIdentity = options?.config?.includeUserIdentity ?? true;
     }
     /**
      * Create the blob with some metadata.
@@ -390,12 +408,16 @@ class BlobStorageService {
      * @param extension Extension for the blob, will be detected if left undefined.
      * @param metadata Data for the custom metadata as JSON-LD.
      * @param namespace The namespace to use for storing, defaults to component configured namespace.
-     * @param nodeIdentity The node identity which controls the vault key.
+     * @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.
      */
-    async create(blob, mimeType, extension, metadata, namespace, nodeIdentity) {
+    async create(blob, mimeType, extension, metadata, namespace, userIdentity, nodeIdentity) {
         core.Guards.stringBase64(this.CLASS_NAME, "blob", blob);
-        if (this._vaultConnector) {
+        if (this._includeUserIdentity) {
+            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 {
@@ -423,12 +445,23 @@ class BlobStorageService {
             }
             // Set the blob in the storage connector, which may now be encrypted
             const blobId = await blobStorageConnector.set(storeBlob);
-            await this._metadataEntityStorage.set({
+            // Now store the metadata in entity storage
+            const blobMetadata = {
                 id: blobId,
                 mimeType,
                 extension,
                 metadata
-            });
+            };
+            const conditions = [];
+            if (this._includeUserIdentity) {
+                core.ObjectHelper.propertySet(blobMetadata, "userIdentity", userIdentity);
+                conditions.push({ property: "userIdentity", value: userIdentity });
+            }
+            if (this._includeNodeIdentity) {
+                core.ObjectHelper.propertySet(blobMetadata, "nodeIdentity", nodeIdentity);
+                conditions.push({ property: "nodeIdentity", value: nodeIdentity });
+            }
+            await this._metadataEntityStorage.set(blobMetadata, conditions);
             return blobId;
         }
         catch (error) {
@@ -439,18 +472,32 @@ class BlobStorageService {
      * Get the blob and metadata.
      * @param id The id of the blob to get in urn format.
      * @param includeContent Include the content, or just get the metadata.
-     * @param nodeIdentity The node identity which controls the vault key.
+     * @param userIdentity The user identity to use with storage operations.
+     * @param nodeIdentity The node identity to use with storage operations.
      * @returns The metadata and data for the blob if it can be found.
      * @throws Not found error if the blob cannot be found.
      */
-    async get(id, includeContent, nodeIdentity) {
+    async get(id, includeContent, userIdentity, nodeIdentity) {
         core.Urn.guard(this.CLASS_NAME, "id", id);
-        if (this._vaultConnector && includeContent) {
+        const conditions = [];
+        if (this._includeUserIdentity) {
+            core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
+            conditions.push({
+                property: "userIdentity",
+                comparison: entity.ComparisonOperator.Equals,
+                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 {
-            // Get the metadata
-            const blobMetadata = await this._metadataEntityStorage.get(id);
+            const blobMetadata = await this.internalGet(id, userIdentity, nodeIdentity);
             let returnBlob;
             if (includeContent) {
                 const blobStorageConnector = this.getConnector(id);
@@ -480,11 +527,19 @@ class BlobStorageService {
      * @param mimeType Mime type for the blob, will be detected if left undefined.
      * @param extension 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, mimeType, extension, metadata) {
+    async update(id, mimeType, extension, metadata, userIdentity, nodeIdentity) {
         core.Urn.guard(this.CLASS_NAME, "id", id);
+        if (this._includeUserIdentity) {
+            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 blobMetadata = await this._metadataEntityStorage.get(id);
             if (core.Is.undefined(blobMetadata)) {
@@ -495,12 +550,23 @@ class BlobStorageService {
                 await dataJsonLd.JsonLdHelper.validate(metadata, validationFailures);
                 core.Validation.asValidationError(this.CLASS_NAME, "metadata", validationFailures);
             }
-            await this._metadataEntityStorage.set({
+            // Now store the metadata in entity storage
+            const updatedBlobMetadata = {
                 id: blobMetadata.id,
                 mimeType: mimeType ?? blobMetadata.mimeType,
                 extension: extension ?? blobMetadata.extension,
                 metadata: metadata ?? blobMetadata.metadata
-            });
+            };
+            const conditions = [];
+            if (this._includeUserIdentity) {
+                core.ObjectHelper.propertySet(updatedBlobMetadata, "userIdentity", userIdentity);
+                conditions.push({ property: "userIdentity", value: userIdentity });
+            }
+            if (this._includeNodeIdentity) {
+                core.ObjectHelper.propertySet(updatedBlobMetadata, "nodeIdentity", nodeIdentity);
+                conditions.push({ property: "nodeIdentity", value: nodeIdentity });
+            }
+            await this._metadataEntityStorage.set(updatedBlobMetadata, conditions);
         }
         catch (error) {
             throw new core.GeneralError(this.CLASS_NAME, "updateFailed", undefined, error);
@@ -509,17 +575,32 @@ 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) {
+    async remove(id, userIdentity, nodeIdentity) {
         core.Urn.guard(this.CLASS_NAME, "id", id);
+        if (this._includeUserIdentity) {
+            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) {
+                conditions.push({ property: "userIdentity", value: userIdentity });
+            }
+            if (this._includeNodeIdentity) {
+                conditions.push({ property: "nodeIdentity", value: nodeIdentity });
+            }
+            await this._metadataEntityStorage.remove(id, conditions);
             const removed = await blobStorageConnector.remove(id);
             if (!removed) {
                 throw new core.NotFoundError(this.CLASS_NAME, "blobNotFound", id);
             }
-            await this._metadataEntityStorage.remove(id);
         }
         catch (error) {
             throw new core.GeneralError(this.CLASS_NAME, "removeFailed", undefined, error);
@@ -541,6 +622,58 @@ class BlobStorageService {
         }
         return blobStorageModels.BlobStorageConnectorFactory.get(idUri.namespaceMethod());
     }
+    /**
+     * Get an entity.
+     * @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) {
+        const conditions = [];
+        if (this._includeUserIdentity) {
+            core.Guards.stringValue(this.CLASS_NAME, "userIdentity", userIdentity);
+            conditions.push({
+                property: "userIdentity",
+                comparison: entity.ComparisonOperator.Equals,
+                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._metadataEntityStorage.get(id);
+        }
+        else {
+            const schema = this._metadataEntityStorage.getSchema();
+            const primaryKey = entity.EntitySchemaHelper.getPrimaryKey(schema);
+            conditions.unshift({
+                property: primaryKey.property,
+                comparison: entity.ComparisonOperator.Equals,
+                value: id
+            });
+            const results = await this._metadataEntityStorage.query({
+                conditions,
+                logicalOperator: entity.LogicalOperator.And
+            }, undefined, undefined, undefined, 1);
+            entity$1 = results.entities[0];
+        }
+        if (core.Is.empty(entity$1)) {
+            throw new core.NotFoundError(this.CLASS_NAME, "entityNotFound", id);
+        }
+        core.ObjectHelper.propertyDelete(entity$1, "nodeIdentity");
+        core.ObjectHelper.propertyDelete(entity$1, "userIdentity");
+        return entity$1;
+    }
 }
 
 /**
@@ -563,6 +696,14 @@ exports.BlobMetadata = class BlobMetadata {
      * The metadata for the blob as JSON-LD.
      */
     metadata;
+    /**
+     * The user identity that created the blob.
+     */
+    userIdentity;
+    /**
+     * The node identity that created the blob.
+     */
+    nodeIdentity;
 };
 __decorate([
     entity.property({ type: "string", isPrimary: true }),
@@ -580,14 +721,27 @@ __decorate([
     entity.property({ type: "object", itemTypeRef: "IJsonLdNodeObject" }),
     __metadata("design:type", Object)
 ], exports.BlobMetadata.prototype, "metadata", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.BlobMetadata.prototype, "userIdentity", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.BlobMetadata.prototype, "nodeIdentity", void 0);
 exports.BlobMetadata = __decorate([
     entity.entity()
 ], exports.BlobMetadata);
 
+/**
+ * These are dummy entry points for the blob storage service.
+ * In reality your application would create its own entry points based on the
+ * blob types it wants to store, using a custom defaultBaseRoute.
+ */
 const restEntryPoints = [
     {
-        name: "blobStorage",
-        defaultBaseRoute: "blob",
+        name: "blob-storage",
+        defaultBaseRoute: "blob-storage",
         tags: tagsBlobStorage,
         generateRoutes: generateRestRoutesBlobStorage
     }