create-openibm 0.1.0

package/dist/templates/nestjs.js

@@ -0,0 +1,477 @@
+import { linkDevScriptMjs } from './basic.js';
+export function nestjsFiles(a) {
+    const hasProgram = a.features.includes('program');
+    const hasTable = a.features.includes('table');
+    return {
+        'package.json': packageJson(a),
+        'tsconfig.json': tsconfig(),
+        'src/main.ts': mainTs(a),
+        'src/app.module.ts': appModuleTs(),
+        'src/ibmi/ibmi.module.ts': ibmiModuleTs(),
+        'src/ibmi/ibmi.service.ts': ibmiServiceTs(a),
+        'src/ibmi/ibmi.controller.ts': ibmiControllerTs(a, hasProgram, hasTable),
+        'src/ibmi/dto/ibmi-validators.ts': ibmiValidatorsNestTs(),
+        ...(hasProgram ? { 'src/ibmi/dto/calculate.dto.ts': calculateDtoTs() } : {}),
+        'scripts/link-dev.mjs': linkDevScriptMjs(),
+        'README.md': readme(a, hasProgram, hasTable),
+    };
+}
+// ── package.json ──────────────────────────────────────────────────────────────
+function packageJson(a) {
+    return JSON.stringify({
+        name: a.projectName,
+        version: '0.1.0',
+        private: true,
+        type: 'module',
+        scripts: {
+            generate: 'openibm generate',
+            build: 'tsc --project tsconfig.json',
+            dev: 'node --env-file=.env --import tsx/esm src/main.ts',
+            start: 'node dist/main.js',
+            'link:dev': 'node scripts/link-dev.mjs',
+        },
+        dependencies: {
+            '@nestjs/common': '^10.0.0',
+            '@nestjs/core': '^10.0.0',
+            '@nestjs/platform-express': '^10.0.0',
+            '@nestjs/swagger': '^7.0.0',
+            '@openibm/driver': '^0.1.0',
+            '@openibm/types': '^0.1.0',
+            'class-transformer': '^0.5.0',
+            'class-validator': '^0.14.0',
+            morgan: '^1.10.0',
+            'reflect-metadata': '^0.1.14',
+            rxjs: '^7.8.0',
+            ...(a.transport === 'odbc' ? { odbc: '^2.4.0' } : {}),
+            ...(a.transport === 'ssh' ? { ssh2: '^1.15.0' } : {}),
+        },
+        devDependencies: {
+            '@openibm/client': '^0.1.0',
+            '@types/morgan': '^1.9.0',
+            '@types/node': '^22.0.0',
+            tsx: '^4.0.0',
+            typescript: '^5.7.0',
+        },
+        engines: { node: '>=20.0.0' },
+    }, null, 4) + '\n';
+}
+// ── tsconfig.json ─────────────────────────────────────────────────────────────
+function tsconfig() {
+    return JSON.stringify({
+        compilerOptions: {
+            target: 'ES2022',
+            module: 'NodeNext',
+            moduleResolution: 'NodeNext',
+            outDir: './dist',
+            rootDir: './src',
+            strict: true,
+            esModuleInterop: true,
+            skipLibCheck: true,
+            experimentalDecorators: true,
+            emitDecoratorMetadata: true,
+            forceConsistentCasingInFileNames: true,
+        },
+        include: ['src'],
+        exclude: ['node_modules', 'dist'],
+    }, null, 4) + '\n';
+}
+// ── src/main.ts ───────────────────────────────────────────────────────────────
+function mainTs(a) {
+    return [
+        `import 'reflect-metadata';`,
+        `import { NestFactory } from '@nestjs/core';`,
+        `import { ValidationPipe } from '@nestjs/common';`,
+        `import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';`,
+        `import morgan from 'morgan';`,
+        `import { AppModule } from './app.module.js';`,
+        ``,
+        `async function bootstrap(): Promise<void> {`,
+        `    const app = await NestFactory.create(AppModule);`,
+        ``,
+        `    // ── HTTP request logging ─────────────────────────────────────────────────`,
+        `    app.use(morgan('dev'));`,
+        ``,
+        `    // ── Global validation pipe (class-validator + class-transformer) ─────────`,
+        `    app.useGlobalPipes(new ValidationPipe({ whitelist: true, transform: true }));`,
+        ``,
+        `    // ── Swagger / OpenAPI ────────────────────────────────────────────────────`,
+        `    const config = new DocumentBuilder()`,
+        `        .setTitle('${a.projectName}')`,
+        `        .setDescription('IBM i REST API')`,
+        `        .setVersion('1.0.0')`,
+        `        .build();`,
+        `    const document = SwaggerModule.createDocument(app, config);`,
+        `    SwaggerModule.setup('api-docs', app, document);`,
+        ``,
+        `    const port = Number(process.env.PORT ?? 3000);`,
+        `    await app.listen(port);`,
+        `    console.log(\`Application: http://localhost:\${port}\`);`,
+        `    console.log(\`Swagger UI:  http://localhost:\${port}/api-docs\`);`,
+        `}`,
+        ``,
+        `bootstrap().catch(console.error);`,
+        ``,
+    ].join('\n');
+}
+// ── src/app.module.ts ─────────────────────────────────────────────────────────
+function appModuleTs() {
+    return [
+        `import { Module } from '@nestjs/common';`,
+        `import { IBMiModule } from './ibmi/ibmi.module.js';`,
+        ``,
+        `@Module({`,
+        `    imports: [IBMiModule],`,
+        `})`,
+        `export class AppModule {}`,
+        ``,
+    ].join('\n');
+}
+// ── src/ibmi/ibmi.module.ts ───────────────────────────────────────────────────
+function ibmiModuleTs() {
+    return [
+        `import { Module } from '@nestjs/common';`,
+        `import { IBMiService } from './ibmi.service.js';`,
+        `import { IBMiController } from './ibmi.controller.js';`,
+        ``,
+        `@Module({`,
+        `    providers:   [IBMiService],`,
+        `    controllers: [IBMiController],`,
+        `    exports:     [IBMiService],`,
+        `})`,
+        `export class IBMiModule {}`,
+        ``,
+    ].join('\n');
+}
+// ── src/ibmi/ibmi.service.ts ──────────────────────────────────────────────────
+function ibmiServiceTs(a) {
+    const httpOptions = (a.transport === 'http' || a.transport === 'https')
+        ? [
+            `            http: {`,
+            `                port:     Number(process.env.IBMI_PORT ?? '${a.transport === 'https' ? 47700 : 57700}'),`,
+            `                database: process.env.IBMI_DATABASE ?? '*LOCAL',`,
+            `            },`,
+        ].join('\n')
+        : '';
+    const sshOptions = a.transport === 'ssh'
+        ? `            ssh: { port: Number(process.env.IBMI_SSH_PORT ?? '22') },`
+        : '';
+    const odbcOptions = a.transport === 'odbc'
+        ? `            odbc: { poolSize: 5 },`
+        : '';
+    const extras = [httpOptions, sshOptions, odbcOptions].filter(Boolean).join('\n');
+    return [
+        `import { Injectable, OnModuleInit, OnModuleDestroy } from '@nestjs/common';`,
+        `import { createClient } from '../generated/ibmi/index.js';`,
+        ``,
+        `@Injectable()`,
+        `export class IBMiService implements OnModuleInit, OnModuleDestroy {`,
+        `    readonly client = createClient({`,
+        `        transport: (process.env.IBMI_TRANSPORT ?? '${a.transport}') as '${a.transport}',`,
+        `        system:    process.env.IBMI_SYSTEM ?? 'localhost',`,
+        `        username:  process.env.IBMI_USER   ?? '',`,
+        `        password:  process.env.IBMI_PASS   ?? '',`,
+        ...(extras ? [extras] : []),
+        `    });`,
+        ``,
+        `    async onModuleInit(): Promise<void> {`,
+        `        await this.client.connect();`,
+        `    }`,
+        ``,
+        `    async onModuleDestroy(): Promise<void> {`,
+        `        await this.client.disconnect();`,
+        `    }`,
+        `}`,
+        ``,
+    ].join('\n');
+}
+// ── src/ibmi/ibmi.controller.ts ───────────────────────────────────────────────
+function ibmiControllerTs(a, hasProgram, hasTable) {
+    const nestImports = ['Controller', 'Get', 'Post', 'Param', 'Body'];
+    const swaggerImports = ['ApiOperation', 'ApiResponse', 'ApiTags'];
+    if (hasTable)
+        swaggerImports.push('ApiParam', 'ApiQuery');
+    if (hasProgram)
+        swaggerImports.push('ApiBody');
+    const imports = [
+        `import { ${nestImports.join(', ')} } from '@nestjs/common';`,
+        `import { ${swaggerImports.join(', ')} } from '@nestjs/swagger';`,
+        `import { IBMiService } from './ibmi.service.js';`,
+        ...(hasProgram ? [`import { CalculateDto } from './dto/calculate.dto.js';`] : []),
+    ];
+    const methods = [
+        `    @Get('health')`,
+        `    @ApiOperation({ summary: 'Connection status' })`,
+        `    @ApiResponse({ status: 200, description: 'OK', schema: { example: { status: 'ok', connected: true } } })`,
+        `    health() {`,
+        `        return { status: 'ok', connected: this.ibmi.client.isConnected() };`,
+        `    }`,
+    ];
+    if (hasTable) {
+        methods.push(``, `    @Get('customers')`, `    @ApiOperation({ summary: 'List customers filtered by state' })`, `    @ApiQuery({ name: 'state', required: false, example: 'TX', description: 'State code — CHAR(2)' })`, `    @ApiResponse({ status: 200, description: 'Array of customer rows' })`, `    async findCustomers(@Param() params: Record<string, string>) {`, `        const state = params['state'] ?? 'TX';`, `        return this.ibmi.client.query.Customer.findMany({`, `            where:   { state },`, `            orderBy: { customerId: 'asc' },`, `            take:    20,`, `        });`, `    }`, ``, `    @Get('customers/:id')`, `    @ApiOperation({ summary: 'Find customer by ID' })`, `    @ApiParam({ name: 'id', type: Number })`, `    @ApiResponse({ status: 200, description: 'Customer row' })`, `    @ApiResponse({ status: 404, description: 'Not found' })`, `    async findCustomer(@Param('id') id: string) {`, `        return this.ibmi.client.query.Customer.findFirst({`, `            where: { customerId: Number(id) },`, `        });`, `    }`);
+    }
+    if (hasProgram) {
+        methods.push(``, `    @Post('calculate')`, `    @ApiOperation({ summary: 'Call SimpleCalc IBM i program' })`, `    @ApiBody({ type: CalculateDto })`, `    @ApiResponse({ status: 200, description: 'Result', schema: { example: { input: 5, output: 500 } } })`, `    async calculate(@Body() body: CalculateDto) {`, `        const result = await this.ibmi.client.program.SimpleCalc({ input: body.input });`, `        return { input: body.input, output: result.output };`, `    }`);
+    }
+    void a;
+    return [
+        ...imports,
+        ``,
+        `@ApiTags('IBM i')`,
+        `@Controller()`,
+        `export class IBMiController {`,
+        `    constructor(private readonly ibmi: IBMiService) {}`,
+        ``,
+        ...methods,
+        `}`,
+        ``,
+    ].join('\n');
+}
+// ── src/ibmi/dto/ibmi-validators.ts ──────────────────────────────────────────
+function ibmiValidatorsNestTs() {
+    return [
+        `/**`,
+        ` * IBM i data-type validators as class-validator decorators.`,
+        ` * Use these in your NestJS DTOs alongside standard class-validator decorators.`,
+        ` *`,
+        ` * Usage:`,
+        ` *   import { IbmiChar, IbmiPackedDecimal, IbmiInt } from './ibmi-validators.js';`,
+        ` *`,
+        ` *   export class MyDto {`,
+        ` *       @IbmiChar(8)   name!: string;`,
+        ` *       @IbmiPackedDecimal(6, 2) balance!: number;`,
+        ` *       @IbmiInt()     id!: number;`,
+        ` *   }`,
+        ` */`,
+        `import { registerDecorator, ValidationOptions, ValidationArguments } from 'class-validator';`,
+        ``,
+        `// ── String types ─────────────────────────────────────────────────────────────`,
+        ``,
+        `/** CHAR(n) — validates that the string is at most n characters */`,
+        `export function IbmiChar(length: number, options?: ValidationOptions) {`,
+        `    return (object: object, propertyName: string) => {`,
+        `        registerDecorator({`,
+        `            name: 'ibmiChar',`,
+        `            target: (object as { constructor: Function }).constructor,`,
+        `            propertyName,`,
+        `            constraints: [length],`,
+        `            options: { message: \`\${propertyName} must be at most \${length} chars (CHAR(\${length}))\`, ...options },`,
+        `            validator: {`,
+        `                validate(value: unknown, args: ValidationArguments) {`,
+        `                    return typeof value === 'string' && value.length <= (args.constraints[0] as number);`,
+        `                },`,
+        `            },`,
+        `        });`,
+        `    };`,
+        `}`,
+        ``,
+        `/** VARCHAR(n) — validates that the string is at most n characters */`,
+        `export function IbmiVarChar(maxLength: number, options?: ValidationOptions) {`,
+        `    return (object: object, propertyName: string) => {`,
+        `        registerDecorator({`,
+        `            name: 'ibmiVarChar',`,
+        `            target: (object as { constructor: Function }).constructor,`,
+        `            propertyName,`,
+        `            constraints: [maxLength],`,
+        `            options: { message: \`\${propertyName} must be at most \${maxLength} chars (VARCHAR(\${maxLength}))\`, ...options },`,
+        `            validator: {`,
+        `                validate(value: unknown, args: ValidationArguments) {`,
+        `                    return typeof value === 'string' && value.length <= (args.constraints[0] as number);`,
+        `                },`,
+        `            },`,
+        `        });`,
+        `    };`,
+        `}`,
+        ``,
+        `// ── Decimal types ────────────────────────────────────────────────────────────`,
+        ``,
+        `/**`,
+        ` * DECIMAL(precision, scale) — packed decimal / zoned decimal.`,
+        ` * e.g. @IbmiPackedDecimal(9, 2) allows -9999999.99 to 9999999.99`,
+        ` */`,
+        `export function IbmiPackedDecimal(precision: number, scale: number, options?: ValidationOptions) {`,
+        `    return (object: object, propertyName: string) => {`,
+        `        registerDecorator({`,
+        `            name: 'ibmiPackedDecimal',`,
+        `            target: (object as { constructor: Function }).constructor,`,
+        `            propertyName,`,
+        `            constraints: [precision, scale],`,
+        `            options: { message: \`\${propertyName} must fit DECIMAL(\${precision},\${scale})\`, ...options },`,
+        `            validator: {`,
+        `                validate(value: unknown, args: ValidationArguments) {`,
+        `                    const [p, s] = args.constraints as [number, number];`,
+        `                    if (typeof value !== 'number') return false;`,
+        `                    if (Math.abs(value) >= Math.pow(10, p - s)) return false;`,
+        `                    return Number.isInteger(Math.round(value * Math.pow(10, s)));`,
+        `                },`,
+        `            },`,
+        `        });`,
+        `    };`,
+        `}`,
+        ``,
+        `/** NUMERIC(precision, scale) — alias for IbmiPackedDecimal */`,
+        `export const IbmiNumeric = IbmiPackedDecimal;`,
+        ``,
+        `// ── Integer types ────────────────────────────────────────────────────────────`,
+        ``,
+        `/** INTEGER — 4-byte signed integer (-2,147,483,648 to 2,147,483,647) */`,
+        `export function IbmiInt(options?: ValidationOptions) {`,
+        `    return (object: object, propertyName: string) => {`,
+        `        registerDecorator({`,
+        `            name: 'ibmiInt',`,
+        `            target: (object as { constructor: Function }).constructor,`,
+        `            propertyName,`,
+        `            constraints: [],`,
+        `            options: { message: \`\${propertyName} must be a 4-byte signed integer\`, ...options },`,
+        `            validator: {`,
+        `                validate(value: unknown) {`,
+        `                    return typeof value === 'number'`,
+        `                        && Number.isInteger(value)`,
+        `                        && value >= -2_147_483_648`,
+        `                        && value <=  2_147_483_647;`,
+        `                },`,
+        `            },`,
+        `        });`,
+        `    };`,
+        `}`,
+        ``,
+        `/** SMALLINT — 2-byte signed integer (-32,768 to 32,767) */`,
+        `export function IbmiSmallInt(options?: ValidationOptions) {`,
+        `    return (object: object, propertyName: string) => {`,
+        `        registerDecorator({`,
+        `            name: 'ibmiSmallInt',`,
+        `            target: (object as { constructor: Function }).constructor,`,
+        `            propertyName,`,
+        `            constraints: [],`,
+        `            options: { message: \`\${propertyName} must be a 2-byte signed integer\`, ...options },`,
+        `            validator: {`,
+        `                validate(value: unknown) {`,
+        `                    return typeof value === 'number'`,
+        `                        && Number.isInteger(value)`,
+        `                        && value >= -32_768`,
+        `                        && value <=  32_767;`,
+        `                },`,
+        `            },`,
+        `        });`,
+        `    };`,
+        `}`,
+        ``,
+        `// ── Date / time types ────────────────────────────────────────────────────────`,
+        ``,
+        `/** DATE — validates ISO date string YYYY-MM-DD */`,
+        `export function IbmiDate(options?: ValidationOptions) {`,
+        `    return (object: object, propertyName: string) => {`,
+        `        registerDecorator({`,
+        `            name: 'ibmiDate',`,
+        `            target: (object as { constructor: Function }).constructor,`,
+        `            propertyName,`,
+        `            constraints: [],`,
+        `            options: { message: \`\${propertyName} must be YYYY-MM-DD (IBM i DATE)\`, ...options },`,
+        `            validator: { validate: (v: unknown) => typeof v === 'string' && /^\\d{4}-\\d{2}-\\d{2}$/.test(v) },`,
+        `        });`,
+        `    };`,
+        `}`,
+        ``,
+        `/** TIMESTAMP — validates IBM i format YYYY-MM-DD-HH.MM.SS.ffffff */`,
+        `export function IbmiTimestamp(options?: ValidationOptions) {`,
+        `    return (object: object, propertyName: string) => {`,
+        `        registerDecorator({`,
+        `            name: 'ibmiTimestamp',`,
+        `            target: (object as { constructor: Function }).constructor,`,
+        `            propertyName,`,
+        `            constraints: [],`,
+        `            options: { message: \`\${propertyName} must be YYYY-MM-DD-HH.MM.SS.ffffff (IBM i TIMESTAMP)\`, ...options },`,
+        `            validator: {`,
+        `                validate: (v: unknown) =>`,
+        `                    typeof v === 'string' && /^\\d{4}-\\d{2}-\\d{2}-\\d{2}\\.\\d{2}\\.\\d{2}\\.\\d{6}$/.test(v),`,
+        `            },`,
+        `        });`,
+        `    };`,
+        `}`,
+        ``,
+    ].join('\n');
+}
+// ── src/ibmi/dto/calculate.dto.ts ─────────────────────────────────────────────
+function calculateDtoTs() {
+    return [
+        `import { IsNumber } from 'class-validator';`,
+        `import { ApiProperty } from '@nestjs/swagger';`,
+        `import { IbmiInt } from './ibmi-validators.js';`,
+        ``,
+        `export class CalculateDto {`,
+        `    @ApiProperty({ example: 5, description: 'Input integer (IBM i INTEGER: -2147483648 to 2147483647)' })`,
+        `    @IsNumber()`,
+        `    @IbmiInt()`,
+        `    input!: number;`,
+        `}`,
+        ``,
+    ].join('\n');
+}
+// ── README.md ─────────────────────────────────────────────────────────────────
+function readme(a, hasProgram, hasTable) {
+    const endpoints = [
+        `| \`GET  /health\`        | Connection status |`,
+        `| \`GET  /api-docs\`      | Swagger UI |`,
+        ...(hasTable ? [`| \`GET  /customers\`    | Query DB2 table (filtered by state) |`] : []),
+        ...(hasTable ? [`| \`GET  /customers/:id\`| Find customer by ID |`] : []),
+        ...(hasProgram ? [`| \`POST /calculate\`    | Call IBM i program (\`{ input: number }\`) |`] : []),
+    ];
+    return [
+        `# ${a.projectName}`,
+        ``,
+        `IBM i NestJS application generated by [create-openibm](https://www.npmjs.com/package/create-openibm).`,
+        ``,
+        `## Setup`,
+        ``,
+        `\`\`\`bash`,
+        `cp .env.example .env`,
+        `# fill in IBMI_SYSTEM, IBMI_USER, IBMI_PASS`,
+        `npm run generate`,
+        `\`\`\``,
+        ``,
+        `## Development`,
+        ``,
+        `\`\`\`bash`,
+        `npm run dev`,
+        `\`\`\``,
+        ``,
+        `## Architecture`,
+        ``,
+        `- **\`IBMiModule\`** — NestJS module that provides and exports \`IBMiService\``,
+        `- **\`IBMiService\`** — wraps the generated client; connects on \`onModuleInit\`, disconnects on \`onModuleDestroy\``,
+        `- **\`IBMiController\`** — exposes HTTP endpoints backed by the IBM i client`,
+        ``,
+        `## Endpoints`,
+        ``,
+        `| Route | Description |`,
+        `|---|---|`,
+        ...endpoints,
+        ``,
+        `## IBM i validators`,
+        ``,
+        `\`src/ibmi/dto/ibmi-validators.ts\` provides class-validator decorators for IBM i data types:`,
+        ``,
+        `\`\`\`ts`,
+        `import { IbmiChar, IbmiPackedDecimal, IbmiInt } from './ibmi-validators.js';`,
+        `import { IsString, IsNumber } from 'class-validator';`,
+        `import { ApiProperty } from '@nestjs/swagger';`,
+        ``,
+        `export class CustomerDto {`,
+        `    @ApiProperty({ example: 'Smith', description: 'CHAR(8)' })`,
+        `    @IsString()`,
+        `    @IbmiChar(8)`,
+        `    lastName!: string;`,
+        ``,
+        `    @ApiProperty({ example: 0.00, description: 'DECIMAL(6,2)' })`,
+        `    @IsNumber()`,
+        `    @IbmiPackedDecimal(6, 2)`,
+        `    balanceDue!: number;`,
+        ``,
+        `    @ApiProperty({ example: 1, description: 'INTEGER' })`,
+        `    @IsNumber()`,
+        `    @IbmiInt()`,
+        `    customerId!: number;`,
+        `}`,
+        `\`\`\``,
+        ``,
+    ].join('\n');
+}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "create-openibm",
+  "version": "0.1.0",
+  "description": "Create a new IBM i application — interactive scaffold with Express, NestJS, or plain Node.js",
+  "license": "MIT",
+  "homepage": "https://github.com/satyamlohiya/openibm",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/satyamlohiya/openibm.git",
+    "directory": "packages/create"
+  },
+  "author": "Satyam Lohiya",
+  "keywords": [
+    "ibm-i",
+    "ibmi",
+    "as400",
+    "iseries",
+    "create-app",
+    "scaffold",
+    "cli",
+    "xmlservice"
+  ],
+  "type": "module",
+  "bin": {
+    "create-openibm": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc --project tsconfig.json",
+    "dev": "tsc --project tsconfig.json --watch",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "try": "node scripts/try.mjs",
+    "link": "pnpm run build && pnpm link --global",
+    "unlink": "pnpm unlink --global create-openibm",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.9.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.7.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}