@chargebee/chargebee-apps 0.0.2

package/dist/commands/package.js

@@ -0,0 +1,93 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.packageCommand = exports.PackageCommand = void 0;
+const chargebee_apps_shared_1 = require("@chargebee/chargebee-apps-shared");
+const chalk_1 = __importDefault(require("chalk"));
+const path_1 = __importDefault(require("path"));
+const registry_1 = require("../registry");
+/**
+ * Package configuration for file inclusion rules
+ * Only includes essential files needed for the serverless application
+ */
+const PACKAGE_CONFIG = {
+    include: {
+        directories: [
+            {
+                name: '.', // Root directory - only include specific files
+                includeFiles: ['manifest.json', 'iparams.json'], // Include manifest.json and iparams.json
+                excludeSubdirs: ['node_modules', 'dist', 'handler', 'test_data', 'types']
+            },
+            {
+                name: 'handler',
+                allowedExtensions: ['.js', '.json'],
+                excludeSubdirs: ['node_modules'],
+                excludeFiles: ['package.json', 'package-lock.json']
+            }
+        ]
+    }
+};
+/**
+ * Main package command class
+ */
+class PackageCommand {
+    constructor(fileSystem, process, fileManagementService, packageValidator, archiveService) {
+        const registry = registry_1.PublicCliRegistry.getInstance();
+        this.fileSystem = fileSystem || registry.fileSystem;
+        this.process = process || registry.process;
+        this.fileManagementService = fileManagementService || new chargebee_apps_shared_1.FileManagementService(this.fileSystem, PACKAGE_CONFIG);
+        this.packageValidator = packageValidator || new chargebee_apps_shared_1.PackageValidator(this.fileSystem);
+        this.archiveService = archiveService || new chargebee_apps_shared_1.ArchiveService(this.fileSystem);
+    }
+    /**
+     * Packages a serverless application into a zip file
+     * @param {string} appDir - The application directory to package
+     * @param {string} packageName - The name of the package
+     */
+    async execute(appDir, options) {
+        const targetDir = path_1.default.resolve(appDir);
+        const appName = path_1.default.basename(targetDir);
+        chargebee_apps_shared_1.__logger.info('Packaging serverless application...');
+        chargebee_apps_shared_1.__logger.info(`App directory: ${targetDir}`);
+        // Validate app directory
+        this.validate(targetDir);
+        chargebee_apps_shared_1.__logger.info(chalk_1.default.green('✓ Valid application directory'));
+        // Determine output path
+        const outputPath = this.fileManagementService.determineOutputPath(targetDir, appName, options.name);
+        // Clean existing packages in dist directory
+        this.fileManagementService.cleanExistingPackages(targetDir);
+        try {
+            const filesToPackage = this.fileManagementService.collectFilesToPackage(targetDir);
+            await this.archiveService.createZipPackage(filesToPackage, targetDir, outputPath);
+        }
+        catch (error) {
+            const err = error;
+            chargebee_apps_shared_1.__logger.error(`Error while creating zip: ${err.message}`);
+            this.process.exit(1);
+        }
+        // Create the zip package
+        chargebee_apps_shared_1.__logger.info(chalk_1.default.green(`✓ Package created successfully: ${outputPath}`));
+        chargebee_apps_shared_1.__logger.info(`Package size: ${this.fileManagementService.getFileSize(outputPath)}`);
+    }
+    validate(targetDir) {
+        if (!this.packageValidator.validateAppDirectoryExists(targetDir)) {
+            chargebee_apps_shared_1.__logger.error('✗ Application directory does not exist');
+            this.process.exit(1);
+        }
+        if (!this.packageValidator.validateManifestExists(targetDir)) {
+            chargebee_apps_shared_1.__logger.error('✗ manifest.json not found in the specified directory');
+            chargebee_apps_shared_1.__logger.info('Make sure you are running the command from a valid serverless app directory');
+            this.process.exit(1);
+        }
+        if (!this.packageValidator.validateHandlerExists(targetDir)) {
+            chargebee_apps_shared_1.__logger.error('✗ handler.js not found in the specified directory');
+            chargebee_apps_shared_1.__logger.info('Make sure you are running the command from a valid serverless app directory');
+            this.process.exit(1);
+        }
+    }
+}
+exports.PackageCommand = PackageCommand;
+// Export for use in commands/index.ts
+exports.packageCommand = new PackageCommand();

package/dist/commands/run.d.ts

@@ -0,0 +1,25 @@
+import { CBFileSystem, CBProcess, DependencyManager, RunOptions } from '@chargebee/chargebee-apps-shared';
+/**
+ * Main run command class
+ */
+export declare class RunCommand {
+    private portService;
+    private process;
+    private fileSystem;
+    private packageValidator;
+    private dependencyManager;
+    private iparamsService;
+    constructor(fileSystem?: CBFileSystem, process?: CBProcess, dependencyManager?: DependencyManager);
+    /**
+     * Starts the local development server for testing serverless applications
+     * @param {string} options - The options for the run command
+     * @param {string} appDir - The application directory to run
+     */
+    execute(options: RunOptions, appDir: string): Promise<void>;
+    /**
+     * Validates manifest and installs dependencies using manifest.dependencies.
+     */
+    private installDependencies;
+    private validate;
+}
+export declare const runCommand: RunCommand;

package/dist/commands/run.js

@@ -0,0 +1,106 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runCommand = exports.RunCommand = void 0;
+const chargebee_apps_libs_1 = require("@chargebee/chargebee-apps-libs");
+const chargebee_apps_shared_1 = require("@chargebee/chargebee-apps-shared");
+const chalk_1 = __importDefault(require("chalk"));
+const path_1 = __importDefault(require("path"));
+const routes_1 = require("../api/routes");
+const registry_1 = require("../registry");
+/**
+ * Main run command class
+ */
+class RunCommand {
+    constructor(fileSystem, process, dependencyManager) {
+        const registry = registry_1.PublicCliRegistry.getInstance();
+        this.process = process || registry.process;
+        this.fileSystem = fileSystem || registry.fileSystem;
+        this.portService = new chargebee_apps_libs_1.PortService();
+        this.packageValidator = new chargebee_apps_shared_1.PackageValidator(registry.fileSystem);
+        this.dependencyManager = dependencyManager || registry.dependencyManager;
+        this.iparamsService = new chargebee_apps_shared_1.IparamsService(registry.fileSystem);
+    }
+    /**
+     * Starts the local development server for testing serverless applications
+     * @param {string} options - The options for the run command
+     * @param {string} appDir - The application directory to run
+     */
+    async execute(options, appDir) {
+        const port = options.port;
+        if (!this.portService.isValidPort(port)) {
+            chargebee_apps_shared_1.__logger.error('Invalid port number: ' + port);
+            this.process.exit(1);
+        }
+        const portNumber = this.portService.parsePort(port);
+        const targetDir = path_1.default.resolve(appDir);
+        chargebee_apps_shared_1.__logger.info('Starting development server...');
+        chargebee_apps_shared_1.__logger.info('');
+        chargebee_apps_shared_1.__logger.info(`App directory: ${targetDir}`);
+        chargebee_apps_shared_1.__logger.info(`Port: ${portNumber}`);
+        chargebee_apps_shared_1.__logger.info('');
+        this.validate(targetDir);
+        await this.installDependencies(targetDir);
+        // Change to the app directory before starting the server
+        this.process.chdir(targetDir);
+        chargebee_apps_shared_1.__logger.info(chalk_1.default.green(`✓ Server started successfully on http://localhost:${portNumber}`));
+        chargebee_apps_shared_1.__logger.info(`Press Ctrl+C to stop the server`);
+        chargebee_apps_shared_1.__logger.info('');
+        // Start the actual API server
+        (0, routes_1.setupServer)(portNumber, targetDir, this.fileSystem, this.process, this.dependencyManager);
+    }
+    /**
+     * Validates manifest and installs dependencies using manifest.dependencies.
+     */
+    async installDependencies(targetDir) {
+        try {
+            const configLoader = new chargebee_apps_libs_1.ConfigLoader(this.fileSystem);
+            const allowedModules = configLoader.loadAllowedModules();
+            const manifestValidator = new chargebee_apps_shared_1.ManifestValidator(allowedModules, this.fileSystem);
+            const manifestPath = path_1.default.join(targetDir, 'manifest.json');
+            const manifest = manifestValidator.validateAndGetManifestFile(manifestPath);
+            await this.dependencyManager.ensureDependencies(targetDir, manifest);
+        }
+        catch (error) {
+            const err = error;
+            chargebee_apps_shared_1.__logger.error('✗ Failed to install dependencies');
+            chargebee_apps_shared_1.__logger.error(err.message);
+            this.process.exit(1);
+        }
+    }
+    validate(targetDir) {
+        // Check if the directory exists
+        if (!this.packageValidator.validateAppDirectoryExists(targetDir)) {
+            chargebee_apps_shared_1.__logger.error('✗ Application directory does not exist');
+            this.process.exit(1);
+        }
+        // Check if it's a valid serverless app directory
+        if (!this.packageValidator.validateManifestExists(targetDir)) {
+            chargebee_apps_shared_1.__logger.error('✗ manifest.json not found in the specified directory');
+            chargebee_apps_shared_1.__logger.error('Make sure you are running the command from a valid serverless app directory');
+            this.process.exit(1);
+        }
+        // Check if the handler.js file exists
+        if (!this.packageValidator.validateHandlerExists(targetDir)) {
+            chargebee_apps_shared_1.__logger.error('✗ handler.js not found in the specified directory');
+            chargebee_apps_shared_1.__logger.error('Make sure you are running the command from a valid serverless app directory');
+            this.process.exit(1);
+        }
+        if (this.iparamsService.iparamsFileExists(targetDir)) {
+            try {
+                this.iparamsService.validateIparamDefns(targetDir);
+                chargebee_apps_shared_1.__logger.debug('✓ iparams.json is valid');
+            }
+            catch (error) {
+                chargebee_apps_shared_1.__logger.error('✗ Invalid iparams.json');
+                chargebee_apps_shared_1.__logger.error(error.message);
+                this.process.exit(1);
+            }
+        }
+    }
+}
+exports.RunCommand = RunCommand;
+// Export for use in commands/index.ts
+exports.runCommand = new RunCommand();

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commands_1 = require("./commands");
+const program = (0, commands_1.setupCLI)();
+program.parse();

package/dist/registry.d.ts

@@ -0,0 +1,17 @@
+import { CBFileSystem, CBProcess, DependencyManager, InternalLogger } from '@chargebee/chargebee-apps-shared';
+/**
+ * Public CLI Registry - Configures all dependencies for public CLI
+ */
+export declare class PublicCliRegistry {
+    private static instance;
+    private _fileSystem;
+    private _process;
+    private _dependencyManager;
+    private _logger;
+    private constructor();
+    static getInstance(): PublicCliRegistry;
+    get fileSystem(): CBFileSystem;
+    get process(): CBProcess;
+    get dependencyManager(): DependencyManager;
+    get logger(): InternalLogger;
+}

package/dist/registry.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicCliRegistry = void 0;
+const chargebee_apps_shared_1 = require("@chargebee/chargebee-apps-shared");
+/**
+ * Public CLI Registry - Configures all dependencies for public CLI
+ */
+class PublicCliRegistry {
+    constructor() {
+        // Initialize with public implementations
+        this._fileSystem = new chargebee_apps_shared_1.FileSystemService();
+        this._process = new chargebee_apps_shared_1.ProcessService();
+        this._dependencyManager = new chargebee_apps_shared_1.DependencyManager(this._fileSystem);
+        // Initialize logger with public CLI configuration
+        const loggerConfig = {
+            useJsonFormat: false
+        };
+        this._logger = new chargebee_apps_shared_1.InternalLogger(loggerConfig);
+    }
+    static getInstance() {
+        if (!PublicCliRegistry.instance) {
+            PublicCliRegistry.instance = new PublicCliRegistry();
+        }
+        return PublicCliRegistry.instance;
+    }
+    get fileSystem() {
+        return this._fileSystem;
+    }
+    get process() {
+        return this._process;
+    }
+    get dependencyManager() {
+        return this._dependencyManager;
+    }
+    get logger() {
+        return this._logger;
+    }
+}
+exports.PublicCliRegistry = PublicCliRegistry;

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@chargebee/chargebee-apps",
+  "version": "0.0.2",
+  "description": "Chargebee Apps CLI tool that enables you to create, test and package the applications",
+  "main": "dist/index.js",
+  "bin": {
+    "chargebee-apps": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "bin",
+    "LICENSE",
+    "SECURITY.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist && rm -rf coverage",
+    "start": "node dist/index.js",
+    "cli": "node dist/index.js",
+    "dev": "ts-node src/index.ts",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "test:coverage:unit": "jest --coverage --testPathPattern=tests/unit",
+    "test:coverage:integration": "jest --coverage --testPathPattern=tests/integration",
+    "test:coverage:detailed": "jest --coverage --coverageReporters=text-lcov --coverageReporters=html --coverageReporters=json",
+    "test:unit": "jest --testPathPattern=tests/unit",
+    "test:integration": "jest --testPathPattern=tests/integration",
+    "minify": "esbuild 'dist/**/*.js' --minify --platform=node --outdir=dist --allow-overwrite"
+  },
+  "dependencies": {
+    "@chargebee/chargebee-apps-libs": "0.0.2",
+    "@chargebee/chargebee-apps-shared": "0.0.2",
+    "archiver": "^7.0.1",
+    "chalk": "^4.1.2",
+    "commander": "^11.0.0",
+    "express": "^5.1.0",
+    "semver": "^7.7.2",
+    "winston": "^3.11.0"
+  },
+  "devDependencies": {
+    "@types/archiver": "^6.0.3",
+    "@types/express": "^4.17.23",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^24.3.0",
+    "@types/semver": "^7.7.0",
+    "@types/supertest": "^6.0.3",
+    "@types/winston": "^2.4.4",
+    "esbuild": "^0.28.1",
+    "jest": "^29.5.0",
+    "mock-fs": "^5.2.0",
+    "supertest": "^6.3.4",
+    "tmp": "^0.2.1",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.0",
+    "typescript": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "config": {
+    "defaultPort": 15000,
+    "defaultTemplate": "serverless-node-starter-app",
+    "defaultPackageName": "app"
+  }
+}