@travetto/manifest 4.1.0 → 5.0.0-rc.1

package/README.md

@@ -35,7 +35,7 @@ During the compilation process, it is helpful to know how the output content dif
 ## Class and Function Metadata
 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 an additional field of `Ⲑid`.  `Ⲑid` represents a computed id that is tied to the file/class combination. 
 
-`Ⲑid` is used heavily throughout the framework for determining which classes are owned by the framework, and being able to lookup the needed data from the [RuntimeIndex](https://github.com/travetto/travetto/tree/main/module/manifest/src/runtime.ts#L14) using the `getFunctionMetadata` method.
+`Ⲑid` is used heavily throughout the framework for determining which classes are owned by the framework, and being able to lookup the needed data from the [RuntimeIndex](https://github.com/travetto/travetto/tree/main/module/manifest/src/runtime.ts#L12) using the `getFunctionMetadata` method.
 
 **Code: Test Class**
 ```typescript
@@ -51,12 +51,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TestClass = void 0;
 const tslib_1 = require("tslib");
 const Ⲑ_runtime_1 = tslib_1.__importStar(require("@travetto/manifest/src/runtime.js"));
+const Ⲑ_decorator_1 = tslib_1.__importStar(require("@travetto/registry/src/decorator.js"));
 var ᚕf = "@travetto/manifest/doc/test-class.js";
-class TestClass {
+let TestClass = class TestClass {
     static Ⲑinit = Ⲑ_runtime_1.RuntimeIndex.registerFunction(TestClass, ᚕf, { hash: 197152026, lines: [1, 3] }, { doStuff: { hash: 51337554, lines: [2, 2] } }, false, false);
     async doStuff() { }
-}
+};
 exports.TestClass = TestClass;
+exports.TestClass = TestClass = tslib_1.__decorate([
+    Ⲑ_decorator_1.Register()
+], TestClass);
 ```
 
 **Terminal: Index Lookup at Runtime**
@@ -85,7 +89,9 @@ Once the manifest is created, the application runtime can now read this manifest
    *  Providing contextual information when provided a filename, import name, etc (e.g. logging, testing output)
 
 ## Path Normalization
-By default, all paths within the framework are assumed to be in a POSIX style, and all input paths are converted to the POSIX style.  This works appropriately within a Unix and a Windows environment.  This module offers up [path](https://github.com/travetto/travetto/tree/main/module/manifest/src/path.ts#L21) as an equivalent to [Node](https://nodejs.org)'s [http](https://nodejs.org/api/path.html) library.  This allows for consistent behavior across all file-interactions, and also allows for easy analysis if [Node](https://nodejs.org)'s [http](https://nodejs.org/api/path.html) library is ever imported.
+By default, all paths within the framework are assumed to be in a POSIX style, and all input paths are converted to the POSIX style.  This works appropriately within a Unix and a Windows environment.  This module offers up [path](https://github.com/travetto/travetto/tree/main/module/manifest/src/path.ts#L9) as an equivalent to [Node](https://nodejs.org)'s [http](https://nodejs.org/api/path.html) library.  This allows for consistent behavior across all file-interactions.
+
+Imports pointing at $`node:path` and $`path` are rewritten at compile time to point to the implementation provided by the module.  This allows for seamless import/usage patterns with the reliability needed for cross platform support.
 
 ## Anatomy of a Manifest
 
@@ -151,7 +157,8 @@ By default, all paths within the framework are assumed to be in a POSIX style, a
           [ "test/fixtures/simple.ts", "fixture", 1868155200000, "test" ]
         ],
         "$transformer": [
-          [ "support/transformer.function-metadata.ts", "ts", 1868155200000, "compile" ]
+          [ "support/transformer.function-metadata.ts", "ts", 1868155200000, "compile" ],
+          [ "support/transformer.rewrite-path-import.ts", "ts", 1868155200000, "compile" ]
         ],
         "src": [
           [ "src/delta.ts", "ts", 1868155200000 ],

package/__index__.ts

@@ -1,6 +1,5 @@
 /// <reference path="./src/global.d.ts" />
 
-export * from './src/path';
 export * from './src/module';
 export * from './src/delta';
 export * from './src/manifest-index';
@@ -11,4 +10,5 @@ export * from './src/file';
 export * from './src/types/context';
 export * from './src/types/package';
 export * from './src/types/manifest';
-export * from './src/types/common';
+export * from './src/types/common';
+export { path } from './src/path';

package/bin/context.d.ts

@@ -1,4 +1,4 @@
-import type { ManifestContext } from '../src/types';
+import type { ManifestContext } from '../src/types/context';
 
 declare namespace ManifestBootstrap {
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/manifest",
-  "version": "4.1.0",
+  "version": "5.0.0-rc.1",
   "description": "Support for project indexing, manifesting, along with file watching",
   "keywords": [
     "path",
@@ -24,7 +24,7 @@
   ],
   "main": "__index__.ts",
   "engines": {
-    "node": ">=20.0.0"
+    "node": ">=22.0.0"
   },
   "repository": {
     "url": "https://github.com/travetto/travetto.git",

package/src/file.ts

@@ -1,4 +1,3 @@
-import os from 'node:os';
 import fs from 'node:fs/promises';
 import { readFileSync } from 'node:fs';
 
@@ -8,15 +7,11 @@ export class ManifestFileUtil {
   /**
    * Write file and copy over when ready
    */
-  static async bufferedFileWrite(file: string, content: string | object): Promise<string> {
-    const ext = path.extname(file);
-    const tempName = `${path.basename(file, ext)}.${process.ppid}.${process.pid}.${Date.now()}.${Math.random()}${ext}`;
+  static async bufferedFileWrite(file: string, content: string): Promise<void> {
+    const temp = path.resolve(path.dirname(file), `.${process.hrtime()[0]}.${path.basename(file)}`);
     await fs.mkdir(path.dirname(file), { recursive: true });
-    const temp = path.resolve(os.tmpdir(), tempName);
-    await fs.writeFile(temp, typeof content === 'string' ? content : JSON.stringify(content), 'utf8');
-    await fs.copyFile(temp, file);
-    fs.unlink(temp); // Don't wait for completion
-    return file;
+    await fs.writeFile(temp, content, 'utf8');
+    await fs.rename(temp, file);
   }
 
   /**

package/src/package.ts

@@ -98,7 +98,7 @@ export class PackageUtil {
             break;
           }
         }
-        await ManifestFileUtil.bufferedFileWrite(cache, out);
+        await ManifestFileUtil.bufferedFileWrite(cache, JSON.stringify(out));
         return out;
       });
   }

package/src/path.ts

@@ -1,35 +1,45 @@
-import type * as pathMod from 'node:path';
-import { extname, dirname, basename, resolve, join } from 'node:path/posix';
-import { sep, resolve as nativeResolve, join as nativeJoin } from 'node:path';
+import posix from 'node:path/posix';
+import win32 from 'node:path/win32';
+import native from 'node:path';
 
-/**
- * Converts a given file name by replace all slashes, with forward slashes
- */
 const toPosix = (file: string): string => file.replaceAll('\\', '/');
-/**
- * Converts a given file name by replace all slashes, with platform dependent path separators
- */
-const toNative = (file: string): string => file.replace(/[\\\/]+/g, sep);
-
+const toNative = (file: string): string => file.replace(/[\/]/g, native.sep);
 const cwd = (): string => toPosix(process.cwd());
 
-type PathModType =
-  { toPosix: typeof toPosix, toNative: typeof toNative } &
-  Pick<typeof pathMod, 'basename' | 'dirname' | 'extname' | 'join' | 'resolve'> &
-  Pick<typeof process, 'cwd'>;
-
-export const path: PathModType = {
-  cwd,
-  toPosix,
+export const path: posix.PlatformPath & {
+  native: posix.PlatformPath;
+  toPosix: typeof toPosix;
+  toNative: typeof toNative;
+} = {
+  sep: posix.sep,
+  delimiter: posix.delimiter,
+  posix,
+  win32,
+  native,
+  basename: (file, suffix) => posix.basename(toPosix(file), suffix),
+  extname: file => posix.extname(toPosix(file)),
+  dirname: file => posix.dirname(toPosix(file)),
   toNative,
-  basename: (file, suffix) => basename(toPosix(file), suffix),
-  extname: file => extname(toPosix(file)),
-  dirname: file => dirname(toPosix(file)),
-  resolve: (...args) => resolve(cwd(), ...args.map(toPosix)),
-  join: (...args) => join(...args.map(toPosix)),
+  toPosix,
+  ...process.platform === 'win32' ? {
+    resolve: (...args) => toPosix(native.resolve(cwd(), ...args.map(toPosix))),
+    join: (root, ...args) => toPosix(native.join(toPosix(root), ...args.map(toPosix))),
+    relative: (from, to) => toPosix(native.relative(toPosix(from), toPosix(to))),
+    isAbsolute: (file) => native.isAbsolute(toPosix(file)),
+    normalize: (file) => toPosix(native.normalize(toPosix(file))),
+    parse: (file) => native.parse(toPosix(file)),
+    format: (obj) => toPosix(native.format(obj)),
+    toNamespacedPath: (file) => toPosix(native.toNamespacedPath(toPosix(file))),
+  } : {
+    relative: (from, to) => posix.relative(toPosix(from), toPosix(to)),
+    resolve: (...args) => posix.resolve(cwd(), ...args.map(toPosix)),
+    join: (...args) => posix.join(...args.map(toPosix)),
+    isAbsolute: file => posix.isAbsolute(toPosix(file)),
+    normalize: file => posix.normalize(toPosix(file)),
+    parse: file => posix.parse(toPosix(file)),
+    format: obj => posix.format(obj),
+    toNamespacedPath: file => toPosix(file),
+  }
 };
 
-if (process.platform === 'win32') {
-  path.resolve = (...args: string[]): string => toPosix(nativeResolve(cwd(), ...args.map(toPosix)));
-  path.join = (root: string, ...args: string[]): string => toPosix(nativeJoin(toPosix(root), ...args.map(toPosix)));
-}
+export default path;

package/src/runtime.ts

@@ -1,9 +1,7 @@
 import { path } from './path';
 import { ManifestIndex } from './manifest-index';
-
 import type { FunctionMetadata, FunctionMetadataTag } from './types/common';
 import type { IndexedModule, ManifestModule } from './types/manifest';
-import type { ManifestContext } from './types/context';
 
 const METADATA = Symbol.for('@travetto/manifest:metadata');
 type Metadated = { [METADATA]: FunctionMetadata };
@@ -40,9 +38,9 @@ class $RuntimeIndex extends ManifestIndex {
   }
 
   /**
-  * Get source file from import location
-  * @param outputFile
-  */
+   * Get source file from import location
+   * @param outputFile
+   */
   getSourceFile(importFile: string): string {
     return this.getFromImport(importFile)?.sourceFile ?? importFile;
   }
@@ -56,6 +54,7 @@ class $RuntimeIndex extends ManifestIndex {
    * @param `methods` Methods and their hashes
    * @param `abstract` Is the class abstract
    * @param `synthetic` Is this code generated at build time
+   * @private
    */
   registerFunction(
     cls: Function, fileOrImport: string, tag: FunctionMetadataTag,
@@ -81,7 +80,7 @@ class $RuntimeIndex extends ManifestIndex {
   /**
    * Retrieve function metadata by function, or function id
    */
-  getFunctionMetadata(clsId: string | Function): FunctionMetadata | undefined {
+  getFunctionMetadata(clsId?: string | Function): FunctionMetadata | undefined {
     const id = clsId === undefined ? '' : typeof clsId === 'string' ? clsId : clsId.Ⲑid;
     return this.#metadata.get(id);
   }
@@ -113,43 +112,4 @@ class $RuntimeIndex extends ManifestIndex {
   }
 }
 
-export const RuntimeIndex = new $RuntimeIndex(process.env.TRV_MANIFEST!);
-
-const build = <T extends object, K extends keyof ManifestContext>(inp: T, props: K[]): T & Pick<ManifestContext, K> => {
-  for (const prop of props) {
-    Object.defineProperty(inp, prop, { configurable: false, get: () => RuntimeIndex.manifest[prop] });
-  }
-  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-  return inp as T & ManifestContext;
-};
-
-export const RuntimeContext = build({
-  /**
-   * Produce a workspace relative path
-   * @param rel The relative path
-   */
-  workspaceRelative(...rel: string[]): string {
-    return path.resolve(RuntimeIndex.manifest.workspace.path, ...rel);
-  },
-  /**
-   * Strip off the workspace path from a file
-   * @param full A full path
-   */
-  stripWorkspacePath(full: string): string {
-    return full === RuntimeIndex.manifest.workspace.path ? '' : full.replace(`${RuntimeIndex.manifest.workspace.path}/`, '');
-  },
-  /**
-   * Produce a workspace path for tooling, with '@' being replaced by node_module/name folder
-   * @param rel The relative path
-   */
-  toolPath(...rel: string[]): string {
-    rel = rel.flatMap(x => x === '@' ? ['node_modules', RuntimeIndex.manifest.main.name] : [x]);
-    return path.resolve(RuntimeIndex.manifest.workspace.path, RuntimeIndex.manifest.build.toolFolder, ...rel);
-  },
-  /**
-   * Are we running from a mono-root?
-   */
-  get monoRoot(): boolean {
-    return !!RuntimeIndex.manifest.workspace.mono && !RuntimeIndex.manifest.main.folder;
-  }
-}, ['main', 'workspace']);
+export const RuntimeIndex = new $RuntimeIndex(process.env.TRV_MANIFEST!);

package/src/util.ts

@@ -69,8 +69,8 @@ export class ManifestUtil {
     const manifest: ManifestRoot = ManifestFileUtil.readAsJsonSync(file);
     // Support packaged environments, by allowing empty manifest.build.outputFolder
     if (manifest.build.outputFolder === '$$PRODUCTION$$') {
-      manifest.build.outputFolder = path.cwd();
-      manifest.workspace.path = path.cwd();
+      manifest.build.outputFolder = path.resolve();
+      manifest.workspace.path = path.resolve();
     }
     return manifest;
   }

package/support/transformer.function-metadata.ts

@@ -8,9 +8,10 @@ import {
 import type { FunctionMetadataTag } from '../src/types/common';
 
 const MANIFEST_MOD = '@travetto/manifest';
+const MANIFEST_MOD_SRC = `${MANIFEST_MOD}/src`;
 const MANIFEST_IDX = `${MANIFEST_MOD}/__index__`;
 
-const RUNTIME_IDX_IMPORT = `${MANIFEST_MOD}/src/runtime`;
+const RUNTIME_IDX_IMPORT = `${MANIFEST_MOD_SRC}/runtime`;
 const RUNTIME_IDX_CLS = 'RuntimeIndex';
 
 const methods = Symbol.for(`${MANIFEST_MOD}:methods`);
@@ -41,7 +42,7 @@ export class RegisterTransformer {
   }
 
   static #valid({ importName: imp }: TransformerState): boolean {
-    return !imp.startsWith(MANIFEST_MOD) || !(/[/](src|support)[/]/.test(imp) || imp === MANIFEST_IDX);
+    return !imp.startsWith(MANIFEST_MOD_SRC) && imp !== MANIFEST_IDX;
   }
 
   /**

package/support/transformer.rewrite-path-import.ts

@@ -0,0 +1,39 @@
+import ts from 'typescript';
+
+import { TransformerState, OnFile } from '@travetto/transformer';
+
+const PATH_REGEX = /^['"](node:)?path['"]$/;
+const PATH_TARGET = '@travetto/manifest/src/path';
+const SKIP_SRC = /^@travetto\/manifest\/(src|support)/;
+
+/**
+ * Rewriting path imports to use manifest's path
+ */
+export class PathImportTransformer {
+
+  /**
+   * Hash each class
+   */
+  @OnFile()
+  static rewritePathImport(state: TransformerState, node: ts.SourceFile): ts.SourceFile {
+    if (SKIP_SRC.test(state.importName)) {
+      return node;
+    }
+
+    const stmt = node.statements.find((x): x is ts.ImportDeclaration =>
+      ts.isImportDeclaration(x) && PATH_REGEX.test(x.moduleSpecifier?.getText() ?? ''));
+    if (stmt) {
+      const updated = state.factory.updateImportDeclaration(
+        stmt,
+        stmt.modifiers,
+        stmt.importClause,
+        state.factory.createStringLiteral(PATH_TARGET),
+        stmt.attributes
+      );
+      return state.factory.updateSourceFile(node, node.statements.map(x =>
+        x === stmt ? updated : x
+      ));
+    }
+    return node;
+  }
+}