@travetto/model 5.0.6 → 5.0.8

package/README.md

@@ -179,13 +179,36 @@ export interface ModelBlobSupport {
    * Get metadata for blob
    * @param location The location of the blob
    */
-  describeBlob(location: string): Promise<BlobMeta>;
+  getBlobMeta(location: string): Promise<BlobMeta>;
 
   /**
    * Delete blob by location
    * @param location The location of the blob
    */
   deleteBlob(location: string): Promise<void>;
+
+  /**
+   * Update blob metadata
+   * @param location The location of the blob
+   */
+  updateBlobMeta(location: string, meta: BlobMeta): Promise<void>;
+
+  /**
+   * Produces an externally usable URL for sharing limited read access to a specific resource
+   *
+   * @param location The asset location to read from
+   * @param exp Expiry
+   */
+  getBlobReadUrl?(location: string, exp?: TimeSpan): Promise<string>;
+
+  /**
+   * Produces an externally usable URL for sharing allowing direct write access
+   *
+   * @param location The asset location to write to
+   * @param meta The metadata to associate with the final asset
+   * @param exp Expiry
+   */
+  getBlobWriteUrl?(location: string, meta: BlobMeta, exp?: TimeSpan): Promise<string>;
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model",
-  "version": "5.0.6",
+  "version": "5.0.8",
   "description": "Datastore abstraction for core operations.",
   "keywords": [
     "datastore",
@@ -26,14 +26,14 @@
     "directory": "module/model"
   },
   "dependencies": {
-    "@travetto/config": "^5.0.6",
-    "@travetto/di": "^5.0.6",
-    "@travetto/registry": "^5.0.6",
-    "@travetto/schema": "^5.0.6"
+    "@travetto/config": "^5.0.7",
+    "@travetto/di": "^5.0.7",
+    "@travetto/registry": "^5.0.7",
+    "@travetto/schema": "^5.0.7"
   },
   "peerDependencies": {
-    "@travetto/cli": "^5.0.6",
-    "@travetto/test": "^5.0.6"
+    "@travetto/cli": "^5.0.7",
+    "@travetto/test": "^5.0.7"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/internal/service/common.ts

@@ -31,7 +31,7 @@ export const isCrudSupported = hasFunction<ModelCrudSupport>('upsert');
 export const isExpirySupported = hasFunction<ModelExpirySupport>('deleteExpired');
 
 /**
- * Type guard for determining if service supports streaming operation
+ * Type guard for determining if service supports blob operations
  */
 export const isBlobSupported = hasFunction<ModelBlobSupport>('getBlob');
 
@@ -41,7 +41,7 @@ export const isBlobSupported = hasFunction<ModelBlobSupport>('getBlob');
 export const isStorageSupported = hasFunction<ModelStorageSupport>('createStorage');
 
 /**
- * Type guard for determining if service supports streaming operation
+ * Type guard for determining if service supports bulk operation
  */
 export const isBulkSupported = hasFunction<ModelBulkSupport>('processBulk');
 

package/src/service/blob.ts

@@ -1,4 +1,4 @@
-import { BinaryInput, BlobMeta, ByteRange } from '@travetto/runtime';
+import { BinaryInput, BlobMeta, ByteRange, TimeSpan } from '@travetto/runtime';
 
 /**
  * Support for Blobs CRUD.
@@ -26,11 +26,34 @@ export interface ModelBlobSupport {
    * Get metadata for blob
    * @param location The location of the blob
    */
-  describeBlob(location: string): Promise<BlobMeta>;
+  getBlobMeta(location: string): Promise<BlobMeta>;
 
   /**
    * Delete blob by location
    * @param location The location of the blob
    */
   deleteBlob(location: string): Promise<void>;
+
+  /**
+   * Update blob metadata
+   * @param location The location of the blob
+   */
+  updateBlobMeta(location: string, meta: BlobMeta): Promise<void>;
+
+  /**
+   * Produces an externally usable URL for sharing limited read access to a specific resource
+   *
+   * @param location The asset location to read from
+   * @param exp Expiry
+   */
+  getBlobReadUrl?(location: string, exp?: TimeSpan): Promise<string>;
+
+  /**
+   * Produces an externally usable URL for sharing allowing direct write access
+   *
+   * @param location The asset location to write to
+   * @param meta The metadata to associate with the final asset
+   * @param exp Expiry
+   */
+  getBlobWriteUrl?(location: string, meta: BlobMeta, exp?: TimeSpan): Promise<string>;
 }

package/support/test/blob.ts

@@ -22,8 +22,8 @@ export abstract class ModelBlobSuite extends BaseModelSuite<ModelBlobSupport> {
     const id = Util.uuid();
 
     await service.upsertBlob(id, buffer);
-    const m = await service.describeBlob(id);
-    const retrieved = await service.describeBlob(id);
+    const m = await service.getBlobMeta(id);
+    const retrieved = await service.getBlobMeta(id);
     assert.deepStrictEqual(m, retrieved);
   }
 
@@ -35,13 +35,13 @@ export abstract class ModelBlobSuite extends BaseModelSuite<ModelBlobSupport> {
     const id = Util.uuid();
 
     await service.upsertBlob(id, buffer, { hash: '10' });
-    assert((await service.describeBlob(id)).hash === '10');
+    assert((await service.getBlobMeta(id)).hash === '10');
 
     await service.upsertBlob(id, buffer, { hash: '20' });
-    assert((await service.describeBlob(id)).hash === '20');
+    assert((await service.getBlobMeta(id)).hash === '20');
 
     await service.upsertBlob(id, buffer, { hash: '30' }, false);
-    assert((await service.describeBlob(id)).hash === '20');
+    assert((await service.getBlobMeta(id)).hash === '20');
   }
 
   @Test()
@@ -51,7 +51,7 @@ export abstract class ModelBlobSuite extends BaseModelSuite<ModelBlobSupport> {
 
     const id = Util.uuid();
     await service.upsertBlob(id, buffer);
-    const { hash } = await service.describeBlob(id);
+    const { hash } = await service.getBlobMeta(id);
 
     const retrieved = await service.getBlob(id);
     const { hash: received } = meta(retrieved)!;
@@ -133,4 +133,65 @@ export abstract class ModelBlobSuite extends BaseModelSuite<ModelBlobSupport> {
     assert('asset.yml' === savedMeta.filename);
     assert(undefined === savedMeta.hash);
   }
+
+
+  @Test()
+  async metadataUpdate() {
+    const service = await this.service;
+
+    await this.writeAndGet();
+
+    await service.updateBlobMeta('orange', {
+      contentType: 'text/yml',
+      filename: 'orange.yml'
+    });
+
+    const savedMeta = await service.getBlobMeta('orange');
+
+    assert('text/yml' === savedMeta.contentType);
+    assert('orange.yml' === savedMeta.filename);
+    assert(undefined === savedMeta.hash);
+  }
+
+
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+  @Test({ skip: (x: unknown) => !(x as ModelBlobSuite).serviceClass.prototype.getBlobWriteUrl })
+  async signedUrl() {
+    const service = await this.service;
+
+
+    const buffer = Buffer.alloc(1.5 * 10000);
+    for (let i = 0; i < buffer.length; i++) {
+      buffer.writeUInt8(Math.trunc(Math.random() * 255), i);
+    }
+
+    const writable = await service.getBlobWriteUrl!('largeFile/one', {
+      contentType: 'image/jpeg',
+    });
+
+    console.log(writable);
+    assert(writable);
+
+    const res = await fetch(writable, {
+      method: 'PUT',
+      body: new File([buffer], 'gary', { type: 'image/jpeg' }),
+    });
+
+    console.error(await res.text());
+
+    assert(res.ok);
+
+    await service.updateBlobMeta('largeFile/one', {
+      contentType: 'image/jpeg',
+      title: 'orange',
+      filename: 'gary',
+      size: buffer.length,
+    });
+
+    const found = await service.getBlob('largeFile/one');
+    assert(found.size === buffer.length);
+    assert(found.type === 'image/jpeg');
+    assert(BinaryUtil.getBlobMeta(found)?.title === 'orange');
+    assert(BinaryUtil.getBlobMeta(found)?.filename === 'gary');
+  }
 }