@fgv/ts-res-cli 5.0.0-3 → 5.0.0-30

package/README.md

@@ -33,6 +33,13 @@ ts-res-compile compile \
   -o ./dist/resources.ts \
   --format ts \
   --include-metadata
+
+# Create a complete bundle with metadata and configuration
+ts-res-compile compile \
+  -i ./resources \
+  -o ./dist/resources.bundle.json \
+  --format bundle \
+  --include-metadata
 ```
 
 ### Validate Resources
@@ -66,7 +73,7 @@ Compiles resources from input to output format.
 
 **Optional Options:**
 - `-c, --context <json>` - Context filter for resources (JSON string)
-- `-f, --format <format>` - Output format (json, js, ts, binary) [default: json]
+- `-f, --format <format>` - Output format (compiled, source, js, ts, binary, bundle) [default: compiled]
 - `--debug` - Include debug information [default: false]
 - `-v, --verbose` - Verbose output [default: false]
 - `-q, --quiet` - Quiet output [default: false]
@@ -134,7 +141,8 @@ The CLI supports the following input formats:
 
 ## Output Formats
 
-### JSON (default)
+### Compiled (default)
+Compiled resource collection optimized for runtime use:
 ```json
 {
   "resources": {
@@ -145,6 +153,46 @@ The CLI supports the following input formats:
 }
 ```
 
+### Source
+Original resource collection format:
+```json
+{
+  "resources": [
+    {
+      "id": "welcome.message",
+      "resourceTypeName": "json",
+      "candidates": [
+        {
+          "json": { "text": "Welcome!" },
+          "conditions": { "language": "en" }
+        }
+      ]
+    }
+  ]
+}
+```
+
+### Bundle
+Complete resource bundle with metadata, configuration, and compiled resources:
+```json
+{
+  "metadata": {
+    "dateBuilt": "2025-01-01T00:00:00.000Z",
+    "checksum": "abc12345",
+    "version": "1.0.0",
+    "description": "Generated bundle from ts-res-cli"
+  },
+  "config": {
+    "qualifierTypes": [...],
+    "qualifiers": [...],
+    "resourceTypes": [...]
+  },
+  "compiledCollection": {
+    "resources": {...}
+  }
+}
+```
+
 ### JavaScript
 ```javascript
 module.exports = {

package/eslint.config.js

@@ -0,0 +1,16 @@
+// ESLint 9 flat config
+const nodeProfile = require('@rushstack/eslint-config/flat/profile/node');
+const packletsPlugin = require('@rushstack/eslint-config/flat/mixins/packlets');
+const tsdocPlugin = require('@rushstack/eslint-config/flat/mixins/tsdoc');
+
+module.exports = [
+  ...nodeProfile,
+  packletsPlugin,
+  ...tsdocPlugin,
+  {
+    // Override specific rules if needed
+    rules: {
+      '@rushstack/packlets/mechanics': 'warn'
+    }
+  }
+];

package/lib/cli.d.ts

@@ -28,6 +28,10 @@ export declare class TsResCliApp {
      * Handles the config command
      */
     private _handleConfigCommand;
+    /**
+     * Handles the archive command
+     */
+    private _handleArchiveCommand;
     /**
      * Parses and validates compile options
      */

package/lib/cli.js

@@ -90,7 +90,7 @@ class TsResCliApp {
             .option('-c, --context <json>', 'Context filter for resources (JSON string)')
             .option('--context-filter <token>', 'Context filter token (pipe-separated, e.g., "language=en-US|territory=US")')
             .option('--qualifier-defaults <token>', 'Qualifier default values token (pipe-separated, e.g., "language=en-US,en-CA|territory=US")')
-            .option('-f, --format <format>', 'Output format', 'compiled')
+            .option('-f, --format <format>', 'Output format (compiled, source, js, ts, binary, bundle)', 'compiled')
             .option('--debug', 'Include debug information', false)
             .option('-v, --verbose', 'Verbose output', false)
             .option('-q, --quiet', 'Quiet output', false)
@@ -142,6 +142,17 @@ class TsResCliApp {
             .action(async (options) => {
             await this._handleConfigCommand(options);
         });
+        this._program
+            .command('archive')
+            .description('Create ZIP archive of resources and configuration')
+            .option('-i, --input <path>', 'Input file or directory path')
+            .option('--config <path>', 'Configuration file path')
+            .requiredOption('-o, --output <path>', 'Output ZIP file path')
+            .option('-v, --verbose', 'Verbose output', false)
+            .option('-q, --quiet', 'Quiet output', false)
+            .action(async (options) => {
+            await this._handleArchiveCommand(options);
+        });
     }
     /**
      * Handles the compile command
@@ -413,13 +424,68 @@ class TsResCliApp {
             process.exit(1);
         }
     }
+    /**
+     * Handles the archive command
+     */
+    async _handleArchiveCommand(options) {
+        try {
+            // Import ZipArchive dynamically to avoid loading if not needed
+            const { ZipArchive } = await Promise.resolve().then(() => __importStar(require('@fgv/ts-res')));
+            if (!options.input && !options.config) {
+                console.error('Error: At least one of --input or --config must be specified');
+                process.exit(1);
+            }
+            if (!options.quiet) {
+                console.log('Creating ZIP archive...');
+                if (options.input)
+                    console.log(`Input: ${options.input}`);
+                if (options.config)
+                    console.log(`Config: ${options.config}`);
+                console.log(`Output: ${options.output}`);
+            }
+            // Create ZIP archive using the new zip-archive packlet
+            const creator = new ZipArchive.ZipArchiveCreator();
+            const createResult = await creator.createFromBuffer({
+                inputPath: options.input,
+                configPath: options.config
+            }, options.verbose
+                ? (phase, progress, message) => {
+                    console.log(`[${phase}] ${progress}% - ${message}`);
+                }
+                : undefined);
+            if (createResult.isFailure()) {
+                console.error(`Error: Failed to create ZIP archive: ${createResult.message}`);
+                process.exit(1);
+            }
+            const { zipBuffer, manifest, size } = createResult.value;
+            // Write the ZIP buffer to the specified output file
+            const fs = await Promise.resolve().then(() => __importStar(require('fs'))).then((m) => m.promises);
+            const path = await Promise.resolve().then(() => __importStar(require('path')));
+            const outputPath = path.resolve(options.output);
+            const outputDir = path.dirname(outputPath);
+            // Ensure output directory exists
+            await fs.mkdir(outputDir, { recursive: true });
+            // Write ZIP file
+            await fs.writeFile(outputPath, zipBuffer);
+            if (!options.quiet) {
+                console.log(`ZIP archive created successfully: ${outputPath}`);
+                console.log(`Archive size: ${(size / 1024).toFixed(2)} KB`);
+                console.log(`Manifest:`);
+                console.log(JSON.stringify(manifest, null, 2));
+            }
+        }
+        catch (error) {
+            console.error(`Error: ${error instanceof Error ? error.message : String(error)}`);
+            process.exit(1);
+        }
+    }
     /**
      * Parses and validates compile options
      */
     _parseCompileOptions(options) {
         try {
             const format = options.format;
-            if (!['compiled', 'source', 'js', 'ts', 'binary'].includes(format)) {
+            if (!['compiled', 'source', 'js', 'ts', 'binary', 'bundle'].includes(format)) {
                 return (0, ts_utils_1.fail)(`Invalid format: ${format}`);
             }
             // Convert JSON context to contextFilter if provided

package/lib/compiler.d.ts

@@ -25,6 +25,7 @@ export interface IFilteredManager {
 export interface IResourceBlob {
     resources?: TsRes.ResourceJson.Json.IResourceCollectionDecl;
     compiledCollection?: TsRes.ResourceJson.Compiled.ICompiledResourceCollection;
+    bundle?: TsRes.Bundle.IBundle;
     metadata?: IResourceInfo;
 }
 /**
@@ -74,6 +75,10 @@ export declare class ResourceCompiler {
      * Generates a source format blob (legacy format)
      */
     private _generateSourceBlob;
+    /**
+     * Generates a bundle blob
+     */
+    private _generateBundleBlob;
     /**
      * Generates resource information
      */

package/lib/compiler.js

@@ -319,6 +319,9 @@ class ResourceCompiler {
             if (this._options.format === 'compiled') {
                 return this._generateCompiledBlob(filtered);
             }
+            else if (this._options.format === 'bundle') {
+                return this._generateBundleBlob(filtered);
+            }
             else {
                 return this._generateSourceBlob(filtered);
             }
@@ -354,6 +357,32 @@ class ResourceCompiler {
             return (0, ts_utils_1.succeed)(blob);
         });
     }
+    /**
+     * Generates a bundle blob
+     */
+    _generateBundleBlob(filtered) {
+        if (!this._systemConfiguration) {
+            return (0, ts_utils_1.fail)('System configuration is required for bundle generation');
+        }
+        // Create SystemConfiguration from the loaded configuration
+        return TsRes.Config.SystemConfiguration.create(this._systemConfiguration).onSuccess((systemConfig) => {
+            // Create bundle using BundleBuilder
+            const bundleParams = {
+                version: '1.0.0',
+                description: 'Generated bundle from ts-res-cli',
+                normalize: true // Use order-resilient normalization for consistent output
+            };
+            return TsRes.Bundle.BundleBuilder.create(filtered.manager, systemConfig, bundleParams).onSuccess((bundle) => {
+                const blob = {
+                    bundle
+                };
+                if (this._options.includeMetadata) {
+                    blob.metadata = this._generateResourceInfo(filtered);
+                }
+                return (0, ts_utils_1.succeed)(blob);
+            });
+        });
+    }
     /**
      * Generates resource information
      */
@@ -400,6 +429,11 @@ class ResourceCompiler {
                     const binaryData = blob.compiledCollection || blob;
                     content = JSON.stringify(binaryData);
                     break;
+                case 'bundle':
+                    // Bundle format outputs the complete bundle with metadata, config, and compiled resources
+                    const bundleData = this._options.includeMetadata ? blob : blob.bundle;
+                    content = JSON.stringify(bundleData, null, 2);
+                    break;
                 default:
                     return (0, ts_utils_1.fail)(`Unsupported output format: ${this._options.format}`);
             }

package/lib/options.d.ts

@@ -1,7 +1,7 @@
 /**
  * Output format options for resource compilation
  */
-export type OutputFormat = 'compiled' | 'source' | 'js' | 'ts' | 'binary';
+export type OutputFormat = 'compiled' | 'source' | 'js' | 'ts' | 'binary' | 'bundle';
 /**
  * Options for resource compilation
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-res-cli",
-  "version": "5.0.0-3",
+  "version": "5.0.0-30",
   "description": "Command-line interface for ts-res resource compilation and management",
   "main": "lib/index.js",
   "bin": {
@@ -18,26 +18,27 @@
   "license": "MIT",
   "dependencies": {
     "commander": "^11.0.0",
-    "@fgv/ts-res": "5.0.0-3",
-    "@fgv/ts-extras": "5.0.0-3",
-    "@fgv/ts-json": "5.0.0-3",
-    "@fgv/ts-json-base": "5.0.0-3",
-    "@fgv/ts-utils": "5.0.0-3"
+    "@fgv/ts-res": "5.0.0-30",
+    "@fgv/ts-utils": "5.0.0-30",
+    "@fgv/ts-json": "5.0.0-30",
+    "@fgv/ts-json-base": "5.0.0-30",
+    "@fgv/ts-extras": "5.0.0-30"
   },
   "devDependencies": {
-    "@rushstack/heft": "~0.74.0",
-    "@rushstack/heft-node-rig": "~2.9.0",
-    "@rushstack/eslint-config": "~4.4.0",
+    "@rushstack/heft": "0.74.4",
+    "@rushstack/heft-node-rig": "2.9.5",
+    "@rushstack/eslint-config": "4.4.0",
     "@types/heft-jest": "1.0.6",
     "@types/jest": "^29.5.14",
     "@types/node": "^20.14.9",
-    "@typescript-eslint/eslint-plugin": "^7.14.1",
-    "@typescript-eslint/parser": "^7.14.1",
-    "eslint": "^8.57.0",
+    "@typescript-eslint/eslint-plugin": "^8.42.0",
+    "@typescript-eslint/parser": "^8.42.0",
+    "eslint": "^9.35.0",
     "jest": "^29.7.0",
-    "ts-jest": "^29.4.0",
-    "typescript": "^5.7.3",
-    "@fgv/ts-utils-jest": "5.0.0-3"
+    "ts-jest": "^29.4.1",
+    "typescript": "5.8.3",
+    "@rushstack/heft-jest-plugin": "0.16.13",
+    "@fgv/ts-utils-jest": "5.0.0-30"
   },
   "peerDependencies": {
     "typescript": "^5.7.3"
@@ -53,7 +54,7 @@
     "build-docs": "api-documenter markdown --input-folder ./temp --output-folder ./docs",
     "test-handles": "rushx test --detectOpenHandles",
     "clean-jest": "rushx test --clearCache",
-    "build-samples": "node bin/ts-res-compile.js compile -i src/test/data/sample-resources.json -o temp/sample-output.json --include-metadata",
-    "build-samples-all": "npm run build-samples && node bin/ts-res-compile.js compile -i src/test/data/resource-collection.json -o temp/collection-output.json --include-metadata && node bin/ts-res-compile.js compile -i src/test/data/sample-resources.json -o temp/sample-output.js -f js && node bin/ts-res-compile.js compile -i src/test/data/sample-resources.json -o temp/sample-output.ts -f ts"
+    "build-samples": "node bin/ts-res-compile.js compile -i test/data/sample-resources.json -o temp/sample-output.json --include-metadata",
+    "build-samples-all": "rushx build-samples && node bin/ts-res-compile.js compile -i test/data/resource-collection.json -o temp/collection-output.json --include-metadata && node bin/ts-res-compile.js compile -i test/data/sample-resources.json -o temp/sample-output.js -f js && node bin/ts-res-compile.js compile -i test/data/sample-resources.json -o temp/sample-output.ts -f ts"
   }
 }

package/.eslintrc.js

@@ -1,9 +0,0 @@
-// This is a workaround for https://github.com/eslint/eslint/issues/3458
-require('@rushstack/eslint-config/patch/modern-module-resolution');
-
-module.exports = {
-  extends: ['@rushstack/eslint-config/profile/node'],
-  parserOptions: {
-    tsconfigRootDir: __dirname
-  }
-};

package/.rush/temp/chunked-rush-logs/ts-res-cli.build.chunks.jsonl

@@ -1,6 +0,0 @@
-{"kind":"O","text":"Invoking: heft build --clean \n"}
-{"kind":"O","text":" ---- build started ---- \n"}
-{"kind":"O","text":"[build:typescript] Using TypeScript version 5.8.3\n"}
-{"kind":"O","text":"[build:lint] Using ESLint version 8.57.0\n"}
-{"kind":"O","text":" ---- build finished (7.713s) ---- \n"}
-{"kind":"O","text":"-------------------- Finished (7.72s) --------------------\n"}

package/.rush/temp/operation/build/log-chunks.jsonl

@@ -1,6 +0,0 @@
-{"kind":"O","text":"Invoking: heft build --clean \n"}
-{"kind":"O","text":" ---- build started ---- \n"}
-{"kind":"O","text":"[build:typescript] Using TypeScript version 5.8.3\n"}
-{"kind":"O","text":"[build:lint] Using ESLint version 8.57.0\n"}
-{"kind":"O","text":" ---- build finished (7.713s) ---- \n"}
-{"kind":"O","text":"-------------------- Finished (7.72s) --------------------\n"}

package/.rush/temp/operation/build/state.json

@@ -1,3 +0,0 @@
-{
-  "nonCachedDurationMs": 8300.952201000007
-}