@travetto/runtime 5.0.0-rc.11 → 5.0.0-rc.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/runtime",
-  "version": "5.0.0-rc.11",
+  "version": "5.0.0-rc.13",
   "description": "Runtime for travetto applications.",
   "keywords": [
     "console-manager",

package/src/binary.ts

@@ -9,6 +9,9 @@ import { text as toText, arrayBuffer as toBuffer } from 'node:stream/consumers';
 
 import { BinaryInput, BlobMeta } from './types';
 import { AppError } from './error';
+import { Util } from './util';
+
+const BlobMetaⲐ = Symbol.for('@travetto/runtime:blob-meta');
 
 /**
  * Common functions for dealing with binary data/streams
@@ -62,7 +65,9 @@ export class BinaryUtil {
   /**
    * Make a blob, and assign metadata
    */
-  static readableBlob(input: () => (Readable | Promise<Readable>), metadata: BlobMeta): Blob {
+  static readableBlob(input: () => (Readable | Promise<Readable>), metadata: Omit<BlobMeta, 'filename'> & { filename: string }): File;
+  static readableBlob(input: () => (Readable | Promise<Readable>), metadata?: BlobMeta): Blob;
+  static readableBlob(input: () => (Readable | Promise<Readable>), metadata: BlobMeta = {}): Blob | File {
     const go = (): Readable => {
       const stream = new PassThrough();
       Promise.resolve(input()).then(v => v.pipe(stream), (err) => stream.destroy(err));
@@ -74,18 +79,22 @@ export class BinaryUtil {
       new File([], path.basename(metadata.filename), { type: metadata.contentType }) :
       new Blob([], { type: metadata.contentType });
 
-    Object.defineProperties(out, {
+    return Object.defineProperties(out, {
       size: { value: size },
       stream: { value: () => ReadableStream.from(go()) },
       arrayBuffer: { value: () => toBuffer(go()) },
       text: { value: () => toText(go()) },
       bytes: { value: () => toBuffer(go()).then(v => new Uint8Array(v)) },
+      [BlobMetaⲐ]: { value: metadata }
     });
+  }
 
-    // @ts-expect-error
-    out.meta = metadata;
-
-    return out;
+  /**
+   * Get blob metadata
+   */
+  static getBlobMeta(blob: Blob): BlobMeta | undefined {
+    const withMeta: Blob & { [BlobMetaⲐ]?: BlobMeta } = blob;
+    return withMeta[BlobMetaⲐ];
   }
 
   /**
@@ -105,4 +114,19 @@ export class BinaryUtil {
       },
     });
   }
+
+  /**
+   * Get a hashed location/path for a blob
+   */
+  static hashedBlobLocation(meta: BlobMeta): string {
+    const hash = meta.hash ?? Util.uuid();
+
+    let parts = hash.match(/(.{1,4})/g)!.slice();
+    if (parts.length > 4) {
+      parts = [...parts.slice(0, 4), parts.slice(4).join('')];
+    }
+
+    const ext = path.extname(meta.filename ?? '') || '.bin';
+    return `${parts.join('/')}${ext}`;
+  }
 }

package/src/global.d.ts

@@ -1,20 +1,12 @@
-import { BlobMeta } from './types';
+import './types';
 
-// https://github.com/microsoft/TypeScript/issues/59012
 declare const write: unique symbol;
 declare global {
+  // https://github.com/microsoft/TypeScript/issues/59012
   interface WritableStreamDefaultWriter<W = any> {
     [write]?: (a: W) => void;
   }
   interface Function {
     Ⲑid: string;
   }
-
-  interface Blob {
-    readonly meta?: Readonly<BlobMeta>;
-  }
-
-  interface File {
-    readonly meta?: Readonly<BlobMeta>;
-  }
 }