@travetto/pack 8.0.0-alpha.2 → 8.0.0-alpha.21

package/README.md

@@ -22,12 +22,18 @@ There are three primary cli commands for packing your code:
 
 ## CLI - pack
 
-**Terminal: Pack usage**
+**Terminal: Help for pack**
 ```bash
 $ trv pack --help
 
 Usage: pack [options] [args...:string]
 
+Description:
+  Build a standard module package artifact.
+
+  This base command produces the default packaged output and serves as the
+  common entry point for module packaging workflows.
+
 Options:
   -b, --buildDir <string>              Workspace for building (default: "/tmp/<temp-folder>")
   --clean, --no-clean                  Clean workspace (default: true)
@@ -45,7 +51,9 @@ Options:
   -wr, --include-workspace-resources   Include workspace resources (default: false)
   -np, --npm-package <string>          External NPM Packages (default: [])
   -m, --module <module>                Module to run for
-  -h, --help                           display help for command
+  --help                               display help for command
+
+Examples:
 ```
 
 This command line operation will compile your project, and produce a ready to use workspace as a deliverable. Additionally, you can pass in a file to the `eject-file` flag that will allow for a script to be produced (base on the host operating system). 
@@ -88,12 +96,18 @@ Every [Pack](https://github.com/travetto/travetto/tree/main/module/pack#readme "
 ## CLI - pack:zip
 This command is nearly identical to the standard `pack` operation, except for the `output` flag.  In this scenario, the `output` flag determines the location and name of the final zip file.
 
-**Terminal: Pack:zip usage**
+**Terminal: Help for pack:zip**
 ```bash
 $ trv pack:zip --help
 
 Usage: pack:zip [options] [args...:string]
 
+Description:
+  Build a deployable zip artifact using the standard pack pipeline.
+
+  This command runs base packing operations and then compresses the generated
+  output into a single archive file.
+
 Options:
   -b, --buildDir <string>              Workspace for building (default: "/tmp/<temp-folder>")
   --clean, --no-clean                  Clean workspace (default: true)
@@ -111,18 +125,26 @@ Options:
   -wr, --include-workspace-resources   Include workspace resources (default: false)
   -np, --npm-package <string>          External NPM Packages (default: [])
   -m, --module <module>                Module to run for
-  -h, --help                           display help for command
+  --help                               display help for command
+
+Examples:
 ```
 
 ## CLI - pack:docker
 This command starts off identical to the standard `pack` operation, but it contains a few additional flags, and ultimately a few additional operations to support creating of the final [docker](https://www.docker.com/community-edition) image.
 
-**Terminal: Pack:docker usage**
+**Terminal: Help for pack:docker**
 ```bash
 $ trv pack:docker --help
 
 Usage: pack:docker [options] [args...:string]
 
+Description:
+  Build container-ready artifacts and optionally publish Docker images.
+
+  Extends the core pack pipeline with Dockerfile generation and image build/
+  push operations, including runtime user and registry customization.
+
 Options:
   -b, --buildDir <string>                Workspace for building (default: "/tmp/<temp-folder>")
   --clean, --no-clean                    Clean workspace (default: true)
@@ -141,7 +163,7 @@ Options:
   -np, --npm-package <string>            External NPM Packages (default: [])
   -m, --module <module>                  Module to run for
   -df, --docker-factory <string>         Docker Factory source (default: "@travetto/pack/support/pack.dockerfile.ts")
-  -di, --docker-image <string>           Docker Image to extend (default: "node:25-alpine")
+  -di, --docker-image <string>           Docker Image to extend (default: "node:26-alpine")
   -dn, --docker-name <string>            Docker Image Name (default: "<module>")
   -ru, --runtime-user <string>           Docker Runtime user
   -rp, --runtime-package <string>        Docker Runtime Packages (default: [])
@@ -151,7 +173,9 @@ Options:
   -dx, --docker-push                     Docker Push Tags (default: false)
   -db, --docker-build-platform <string>  Docker Build Platform
   -dr, --docker-registry <string>        Docker Registry
-  -h, --help                             display help for command
+  --help                                 display help for command
+
+Examples:
 ```
 
 The additional flags provided are allow for specifying the base image, the final docker image name (and tags), and which registry to push to (if  any).  Additionally, there are flags for exposing which ports the image should expect to open as well.   When using the `--eject-file`  flag, the output script will produce the entire Dockerfile output inline, so that it can be easily modified as needed. 
@@ -244,21 +268,21 @@ cd $TRV_OUT
 node $REPO_ROOT/node_modules/.bin/rollup -c $TRV_OUT/node_modules/@travetto/pack/support/rollup/build.js
 cd $ROOT
 
-# Pulling Docker Base Image node:25-alpine 
+# Pulling Docker Base Image node:26-alpine 
 
-echo "Pulling Docker Base Image node:25-alpine"
+echo "Pulling Docker Base Image node:26-alpine"
 
-docker pull node:25-alpine
+docker pull node:26-alpine
 
-# Detected Image OS node:25-alpine as alpine 
+# Detected Image OS node:26-alpine as alpine 
 
-echo "Detected Image OS node:25-alpine as alpine"
+echo "Detected Image OS node:26-alpine as alpine"
 
 # Generating Docker File $DIST/Dockerfile @travetto/pack/support/pack.dockerfile.ts 
 
 echo "Generating Docker File $DIST/Dockerfile @travetto/pack/support/pack.dockerfile.ts"
 
-echo "FROM node:25-alpine" > $DIST/Dockerfile
+echo "FROM node:26-alpine" > $DIST/Dockerfile
 echo "RUN addgroup -g 2000 app && adduser -D -G app -u 2000 app" >> $DIST/Dockerfile
 echo "RUN mkdir /app && chown app:app /app" >> $DIST/Dockerfile
 echo "COPY --chown=\"app:app\" . /app" >> $DIST/Dockerfile

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/pack",
-  "version": "8.0.0-alpha.2",
+  "version": "8.0.0-alpha.21",
   "type": "module",
   "description": "Code packing utilities",
   "keywords": [
@@ -26,16 +26,16 @@
     "directory": "module/pack"
   },
   "dependencies": {
-    "@rollup/plugin-commonjs": "^29.0.2",
+    "@rollup/plugin-commonjs": "^29.0.3",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@travetto/runtime": "^8.0.0-alpha.1",
-    "@travetto/terminal": "^8.0.0-alpha.1",
-    "rollup": "^4.59.0"
+    "@rollup/plugin-terser": "^1.0.0",
+    "@travetto/runtime": "^8.0.0-alpha.18",
+    "@travetto/terminal": "^8.0.0-alpha.18",
+    "rollup": "^4.61.1"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.2"
+    "@travetto/cli": "^8.0.0-alpha.25"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/support/cli.pack.ts

@@ -1,9 +1,12 @@
 import { CliCommand } from '@travetto/cli';
 
-import { BasePackCommand } from './pack.base';
+import { BasePackCommand } from './pack.base.ts';
 
 /**
- * Standard pack support
+ * Build a standard module package artifact.
+ *
+ * This base command produces the default packaged output and serves as the
+ * common entry point for module packaging workflows.
  */
 @CliCommand()
 export class PackCommand extends BasePackCommand { }

package/support/cli.pack_docker.ts

@@ -5,7 +5,7 @@ import { CliCommand, CliFlag, CliUtil } from '@travetto/cli';
 import { Ignore, Max, Min, Required } from '@travetto/schema';
 
 import { DockerPackOperation } from './bin/docker-operation.ts';
-import { BasePackCommand, type PackOperationShape } from './pack.base';
+import { BasePackCommand, type PackOperationShape } from './pack.base.ts';
 import type { DockerPackConfig } from '../src/types.ts';
 
 const NODE_MAJOR = process.version.match(/\d+/)?.[0] ?? '22';
@@ -13,7 +13,10 @@ const asNumber = (input?: string): number | undefined => (!input || isNaN(+input
 const asString = (input?: string): string | undefined => (input && asNumber(input)) ? input : undefined;
 
 /**
- * Standard docker support for pack
+ * Build container-ready artifacts and optionally publish Docker images.
+ *
+ * Extends the core pack pipeline with Dockerfile generation and image build/
+ * push operations, including runtime user and registry customization.
  */
 @CliCommand()
 export class PackDockerCommand extends BasePackCommand {
@@ -24,7 +27,7 @@ export class PackDockerCommand extends BasePackCommand {
   @CliFlag({ short: 'di', envVars: ['PACK_DOCKER_IMAGE'] })
   dockerImage = `node:${NODE_MAJOR}-alpine`;
   /**  Docker Image Name */
-  @CliFlag({ short: 'dn', envVars: ['PACK_DOCKER_IMAGE'] })
+  @CliFlag({ short: 'dn', envVars: ['PACK_DOCKER_NAME'] })
   @Required(false)
   dockerName: string;
   /**  Docker Runtime user */

package/support/cli.pack_zip.ts

@@ -1,10 +1,13 @@
 import { CliCommand, CliUtil } from '@travetto/cli';
 
 import { PackOperation } from './bin/operation.ts';
-import { BasePackCommand, type PackOperationShape } from './pack.base';
+import { BasePackCommand, type PackOperationShape } from './pack.base.ts';
 
 /**
- * Standard zip support for pack
+ * Build a deployable zip artifact using the standard pack pipeline.
+ *
+ * This command runs base packing operations and then compresses the generated
+ * output into a single archive file.
  */
 @CliCommand()
 export class PackZipCommand extends BasePackCommand {

package/support/pack.base.ts

@@ -5,7 +5,7 @@ import { type CliCommandShape, CliFlag, CliModuleFlag, CliParseUtil, cliTpl } fr
 import { TimeUtil, Runtime, RuntimeIndex } from '@travetto/runtime';
 import { Terminal } from '@travetto/terminal';
 import { Ignore, Method, Required, Schema } from '@travetto/schema';
-import { PackageUtil } from '@travetto/manifest';
+import { PackageUtil, type IndexedModule } from '@travetto/manifest';
 
 import { PackOperation } from './bin/operation.ts';
 import { PackUtil } from './bin/util.ts';
@@ -114,22 +114,21 @@ export abstract class BasePackCommand implements CliCommandShape {
    */
   async * runOperations(): AsyncIterable<string> {
     for (const operation of this.getOperations()) {
-      for await (const msg of operation(this)) {
-        yield msg.join(' ');
+      for await (const message of operation(this)) {
+        yield message.join(' ');
       }
     }
   }
 
   /**
-   * Get all binary dependencies
+   * Get all external dependencies
    */
-  getBinaryDependencies(): string[] {
+  getModuleExternalDependencies(): string[] {
     return [...RuntimeIndex.getModuleList('all')]
       .map(name => RuntimeIndex.getModule(name))
-      .filter(module => !!module)
-      .filter(module => module.production)
+      .filter((module): module is IndexedModule => !!module?.production)
       .map(module => PackageUtil.readPackage(module?.sourcePath))
-      .map(pkg => pkg?.travetto?.build?.binaryDependencies ?? [])
+      .map(pkg => pkg?.travetto?.build?.externalDependencies ?? [])
       .flat();
   }
 
@@ -147,8 +146,8 @@ export abstract class BasePackCommand implements CliCommandShape {
     this.mainName ??= path.basename(this.module);
     this.mainFile = `${this.mainName}.js`;
 
-    // Collect binary dependencies
-    const dependencies = this.getBinaryDependencies();
+    // Collect unmanaged dependencies
+    const dependencies = this.getModuleExternalDependencies();
     this.externalDependencies = [...this.externalDependencies, ...dependencies];
 
     const stream = this.runOperations();
@@ -162,11 +161,11 @@ export abstract class BasePackCommand implements CliCommandShape {
 
       await term.streamLines(stream);
 
-      let msg = cliTpl`${{ success: 'Success' }} (${{ identifier: TimeUtil.asClock(Date.now() - start) }}) ${{ subtitle: 'module' }}=${{ param: this.module }}`;
+      let message = cliTpl`${{ success: 'Success' }} (${{ identifier: TimeUtil.asClock(Date.now() - start) }}) ${{ subtitle: 'module' }}=${{ param: this.module }}`;
       if (this.output) {
-        msg = cliTpl`${msg} ${{ subtitle: 'output' }}=${{ path: this.output }}`;
+        message = cliTpl`${message} ${{ subtitle: 'output' }}=${{ path: this.output }}`;
       }
-      await term.writer.writeLine(msg).commit();
+      await term.writer.writeLine(message).commit();
     }
   }
 }

package/support/rollup/rollup-travetto-import.ts

@@ -1,4 +1,5 @@
 import type { AstNode, Plugin } from 'rollup';
+// @ts-expect-error - This module lacks types
 import { walk } from 'estree-walker';
 import magicString from 'magic-string';
 
@@ -33,16 +34,14 @@ export function travettoImportPlugin(config: CoreRollupConfig): Plugin {
       let ms: magicString | undefined;
 
       walk(parsed, {
-        enter: (node) => {
-          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-          const impNode = node as TNode;
-          if (impNode.type === 'ImportExpression' && impNode.source?.type !== 'Literal') {
-            if (!/["']/.test(code.substring(impNode.start, impNode.end))) {
-              (ms ??= new magicString(code)).overwrite(impNode.start, impNode.start + 6, GLOBAL_IMPORT);
+        enter: (node: TNode) => {
+          if (node.type === 'ImportExpression' && node.source?.type !== 'Literal') {
+            if (!/["']/.test(code.substring(node.start, node.end))) {
+              (ms ??= new magicString(code)).overwrite(node.start, node.start + 6, GLOBAL_IMPORT);
             }
-          } else if (impNode.type === 'CallExpression' && impNode.callee?.type === 'Identifier' && impNode.callee.name === 'require') {
-            if (!/["']/.test(code.substring(impNode.start, impNode.end))) {
-              (ms ??= new magicString(code)).overwrite(impNode.start, impNode.start + 7, GLOBAL_IMPORT);
+          } else if (node.type === 'CallExpression' && node.callee?.type === 'Identifier' && node.callee.name === 'require') {
+            if (!/["']/.test(code.substring(node.start, node.end))) {
+              (ms ??= new magicString(code)).overwrite(node.start, node.start + 7, GLOBAL_IMPORT);
             }
           }
         }

package/support/rollup/rollup-travetto-sourcemaps.ts

@@ -18,7 +18,7 @@ export function travettoSourcemaps(config: CoreRollupConfig): Plugin {
   return {
     name: 'travetto-source-maps',
     async load(this: PluginContext, id: string): Promise<LoadResult> {
-      if (!id.endsWith('.js')) {
+      if (!id.endsWith('.js') || id.endsWith('@travetto/runtime/support/patch.js')) {
         return null;
       }
       try {
@@ -30,8 +30,11 @@ export function travettoSourcemaps(config: CoreRollupConfig): Plugin {
             return null;
           }
           const loader = new FileLoader([path.dirname(id)]);
-          const map = await loader.readText(mapPath)
-            .then(JSONUtil.fromBase64<SourceMapInput>);
+          const map = await loader.readUTF8(mapPath)
+            .then(value => value.startsWith('{') ?
+              JSONUtil.fromUTF8<SourceMapInput>(value) :
+              JSONUtil.fromBase64<SourceMapInput>(value)
+            );
           return { code, map };
         }
         return { code, map: null };