@travetto/runtime 5.0.16 → 6.0.0-rc.0

package/README.md

@@ -65,7 +65,7 @@ class $Runtime {
   /** Get import for function */
   getImport(fn: Function): string;
   /** Import from a given path */
-  importFrom<T = unknown>(imp?: string): Promise<T>;
+  async importFrom<T = unknown>(imp?: string): Promise<T>;
 }
 ```
 
@@ -73,7 +73,7 @@ class $Runtime {
 For the framework to work properly, metadata needs to be collected about files, classes and functions to uniquely identify them, with support for detecting changes during live reloads.  To achieve this, every `class` is decorated with metadata, including methods, line numbers, and ultimately a unique id stored at `Ⲑid`.
 
 ## Environment Support
-The functionality we support for testing and retrieving environment information for known environment variables. They can be accessed directly on the [Env](https://github.com/travetto/travetto/tree/main/module/runtime/src/env.ts#L111) object, and will return a scoped [EnvProp](https://github.com/travetto/travetto/tree/main/module/runtime/src/env.ts#L8), that is compatible with the property definition.  E.g. only showing boolean related fields when the underlying flag supports `true` or `false`
+The functionality we support for testing and retrieving environment information for known environment variables. They can be accessed directly on the [Env](https://github.com/travetto/travetto/tree/main/module/runtime/src/env.ts#L114) object, and will return a scoped [EnvProp](https://github.com/travetto/travetto/tree/main/module/runtime/src/env.ts#L8), that is compatible with the property definition.  E.g. only showing boolean related fields when the underlying flag supports `true` or `false`
 
 **Code: Base Known Environment Flags**
 ```typescript
@@ -140,11 +140,12 @@ For a given [EnvProp](https://github.com/travetto/travetto/tree/main/module/runt
 **Code: EnvProp Shape**
 ```typescript
 export class EnvProp<T> {
-  constructor(public readonly key: string) { }
+  readonly key: string;
+  constructor(key: string) { this.key = key; }
   /** Remove value */
   clear(): void;
   /** Export value */
-  export(val: T | undefined): Record<string, string>;
+  export(val?: T | undefined | null): Record<string, string>;
   /** Read value as string */
   get val(): string | undefined;
   /** Read value as list */
@@ -259,7 +260,7 @@ The primary access patterns for resources, is to directly request a file, and to
 
 The [FileLoader](https://github.com/travetto/travetto/tree/main/module/runtime/src/file-loader.ts#L11) allows for accessing information about the resources, and subsequently reading the file as text/binary or to access the resource as a `Readable` stream.  If a file is not found, it will throw an [AppError](https://github.com/travetto/travetto/tree/main/module/runtime/src/error.ts#L26) with a category of 'notfound'.  
 
-The [FileLoader](https://github.com/travetto/travetto/tree/main/module/runtime/src/file-loader.ts#L11) also supports tying itself to [Env](https://github.com/travetto/travetto/tree/main/module/runtime/src/env.ts#L111)'s `TRV_RESOURCES` information on where to attempt to find a requested resource.
+The [FileLoader](https://github.com/travetto/travetto/tree/main/module/runtime/src/file-loader.ts#L11) also supports tying itself to [Env](https://github.com/travetto/travetto/tree/main/module/runtime/src/env.ts#L114)'s `TRV_RESOURCES` information on where to attempt to find a requested resource.
 
 ## Common Utilities
 Common utilities used throughout the framework. Currently [Util](https://github.com/travetto/travetto/tree/main/module/runtime/src/util.ts#L17) includes:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/runtime",
-  "version": "5.0.16",
+  "version": "6.0.0-rc.0",
   "description": "Runtime for travetto applications.",
   "keywords": [
     "console-manager",
@@ -25,12 +25,12 @@
     "directory": "module/runtime"
   },
   "dependencies": {
-    "@travetto/manifest": "^5.0.12",
+    "@travetto/manifest": "^6.0.0-rc.0",
     "@types/debug": "^4.1.12",
     "debug": "^4.4.0"
   },
   "peerDependencies": {
-    "@travetto/transformer": "^5.0.13"
+    "@travetto/transformer": "^6.0.0-rc.0"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {

package/src/context.ts

@@ -7,6 +7,7 @@ import { type ManifestIndex, type ManifestContext, ManifestModuleUtil } from '@t
 import { Env } from './env';
 import { RuntimeIndex } from './manifest-index';
 import { describeFunction } from './function';
+import { castTo } from './types';
 
 /** Constrained version of {@type ManifestContext} */
 class $Runtime {
@@ -107,7 +108,7 @@ class $Runtime {
   }
 
   /** Import from a given path */
-  importFrom<T = unknown>(imp?: string): Promise<T> {
+  async importFrom<T = unknown>(imp?: string): Promise<T> {
     const file = path.resolve(this.#idx.mainModule.sourcePath, imp!);
     if (existsSync(file)) {
       imp = this.#idx.getFromSource(file)?.import;
@@ -131,7 +132,16 @@ class $Runtime {
     }
 
     imp = ManifestModuleUtil.withOutputExtension(imp);
-    return import(imp);
+    const res = await import(imp);
+    if (res?.default?.default) {
+      // Unpack default.default, typescript does this in a way that requires recreating the whole object
+      const def = res?.default?.default;
+      return Object.defineProperties(castTo({}), {
+        ...Object.getOwnPropertyDescriptors(res),
+        default: { get: () => def, configurable: false }
+      });
+    }
+    return res;
   }
 }
 

package/src/env.ts

@@ -6,7 +6,8 @@ const IS_FALSE = /^(false|no|off|0)$/i;
 export interface EnvData { }
 
 export class EnvProp<T> {
-  constructor(public readonly key: string) { }
+  readonly key: string;
+  constructor(key: string) { this.key = key; }
 
   /** Set value according to prop type */
   set(val: T | undefined | null): void {
@@ -23,9 +24,11 @@ export class EnvProp<T> {
   }
 
   /** Export value */
-  export(val: T | undefined): Record<string, string> {
+  export(val?: T | undefined | null): Record<string, string> {
     let out: string;
-    if (val === undefined || val === '' || val === null) {
+    if (arguments.length === 0) { // If nothing passed in
+      out = `${this.val}`;
+    } else if (val === undefined || val === null) {
       out = '';
     } else if (Array.isArray(val)) {
       out = val.join(',');

package/src/util.ts

@@ -133,4 +133,35 @@ export class Util {
       return () => true;
     }
   }
+
+  /**
+   * Encode JSON value as base64 encoded string
+   */
+  static encodeSafeJSON<T>(value: T | undefined): string | undefined {
+    if (value === undefined) {
+      return;
+    }
+    const res = JSON.stringify(value);
+    return Buffer.from(res, 'utf8').toString('base64');
+  }
+
+  /**
+   * Decode JSON value from base64 encoded string
+   */
+  static decodeSafeJSON<T>(input: string): T;
+  static decodeSafeJSON<T>(input?: string | undefined): T | undefined;
+  static decodeSafeJSON<T>(input?: string | undefined): T | undefined {
+    if (!input) {
+      return undefined;
+    }
+
+    let decoded = Buffer.from(input, 'base64').toString('utf8');
+
+    // Read from encoded if it happens
+    if (decoded.startsWith('%')) {
+      decoded = decodeURIComponent(decoded);
+    }
+
+    return JSON.parse(decoded, undefined);
+  }
 }