create-openibm 0.1.0

package/dist/templates/basic.js

@@ -0,0 +1,323 @@
+export function basicFiles(a) {
+    return {
+        'package.json': packageJson(a),
+        'tsconfig.json': tsconfig(),
+        'src/index.ts': indexTs(a),
+        'src/ibmi-validators.ts': ibmiValidatorsTs(),
+        'scripts/link-dev.mjs': linkDevScriptMjs(),
+        'README.md': readme(a),
+    };
+}
+// ── 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/index.ts',
+            start: 'node dist/index.js',
+            'link:dev': 'node scripts/link-dev.mjs',
+        },
+        dependencies: {
+            '@openibm/driver': '^0.1.0',
+            '@openibm/types': '^0.1.0',
+            zod: '^3.23.0',
+            ...(a.transport === 'odbc' ? { odbc: '^2.4.0' } : {}),
+            ...(a.transport === 'ssh' ? { ssh2: '^1.15.0' } : {}),
+        },
+        devDependencies: {
+            '@openibm/client': '^0.1.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,
+            forceConsistentCasingInFileNames: true,
+        },
+        include: ['src'],
+        exclude: ['node_modules', 'dist'],
+    }, null, 4) + '\n';
+}
+// ── src/index.ts ──────────────────────────────────────────────────────────────
+function indexTs(a) {
+    const hasProgram = a.features.includes('program');
+    const hasTable = a.features.includes('table');
+    const imports = [
+        `import { createClient } from './generated/ibmi/index.js';`,
+        ...(a.transport === 'odbc' ? [`import 'odbc';`] : []),
+    ];
+    const clientConfig = clientConfigBlock(a);
+    const body = [];
+    if (hasProgram) {
+        body.push(`    // ── Program call ─────────────────────────────────────────────────────────`, `    const { output } = await client.program.SimpleCalc({ input: 5 });`, `    console.log('SimpleCalc(5) =>', output); // 500`, ``);
+    }
+    if (hasTable) {
+        body.push(`    // ── Table query ──────────────────────────────────────────────────────────`, `    const customers = await client.query.Customer.findMany({`, `        where:   { state: 'TX' },`, `        orderBy: { customerId: 'asc' },`, `        take:    5,`, `    });`, `    console.log('TX customers:', customers);`, ``, `    const first = await client.query.Customer.findFirst({ orderBy: { customerId: 'asc' } });`, `    console.log('First customer:', first);`, ``);
+    }
+    if (!hasProgram && !hasTable) {
+        body.push(`    // ── Raw SQL ──────────────────────────────────────────────────────────────`, `    const rows = await client.query.sql('SELECT * FROM SYSIBM.SYSDUMMY1');`, `    console.log('SYSDUMMY1:', rows);`, ``);
+    }
+    return [
+        ...imports,
+        ``,
+        clientConfig,
+        ``,
+        `async function main(): Promise<void> {`,
+        `    await client.connect();`,
+        `    console.log('Connected to IBM i');`,
+        ``,
+        ...body,
+        `    await client.disconnect();`,
+        `    console.log('Disconnected.');`,
+        `}`,
+        ``,
+        `main().catch(console.error);`,
+        ``,
+    ].join('\n');
+}
+// ── README.md ─────────────────────────────────────────────────────────────────
+function readme(a) {
+    return [
+        `# ${a.projectName}`,
+        ``,
+        `IBM i Node.js 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`,
+        `\`\`\``,
+        ``,
+        `## Generate the typed client`,
+        ``,
+        `\`\`\`bash`,
+        `npm run generate`,
+        `\`\`\``,
+        ``,
+        `## Development`,
+        ``,
+        `\`\`\`bash`,
+        `npm run dev`,
+        `\`\`\``,
+        ``,
+        `## Build`,
+        ``,
+        `\`\`\`bash`,
+        `npm run build`,
+        `npm start`,
+        `\`\`\``,
+        ``,
+        `## IBM i validators`,
+        ``,
+        `\`src/ibmi-validators.ts\` provides Zod schemas for IBM i data types:`,
+        ``,
+        `\`\`\`ts`,
+        `import { ibmiChar, ibmiPackedDecimal, ibmiInt } from './ibmi-validators.js';`,
+        ``,
+        `const schema = z.object({`,
+        `    name:    ibmiChar(8),               // CHAR(8)`,
+        `    balance: ibmiPackedDecimal(6, 2),    // DECIMAL(6,2)`,
+        `    id:      ibmiInt,                    // INTEGER`,
+        `});`,
+        `\`\`\``,
+        ``,
+    ].join('\n');
+}
+// ── Shared helpers ─────────────────────────────────────────────────────────────
+export function clientConfigBlock(a) {
+    const lines = [
+        `const 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   ?? '',`,
+    ];
+    if (a.transport === 'http' || a.transport === 'https') {
+        const port = a.transport === 'https' ? 47700 : 57700;
+        lines.push(`    http: {`, `        port:     Number(process.env.IBMI_PORT ?? '${port}'),`, `        database: process.env.IBMI_DATABASE ?? '*LOCAL',`, `    },`);
+    }
+    if (a.transport === 'ssh')
+        lines.push(`    ssh:  { port: Number(process.env.IBMI_SSH_PORT ?? '22') },`);
+    if (a.transport === 'odbc')
+        lines.push(`    odbc: { poolSize: 5 },`);
+    lines.push(`});`);
+    return lines.join('\n');
+}
+/**
+ * scripts/link-dev.mjs — shared by all templates.
+ * Uses `pnpm add file:...` so pnpm installs ALL deps in one shot while
+ * pulling @openibm/* from the globally linked monorepo packages.
+ */
+export function linkDevScriptMjs() {
+    return [
+        `/**`,
+        ` * link-dev.mjs`,
+        ` * Installs @openibm/* from the locally linked monorepo without hitting npm.`,
+        ` *`,
+        ` * Strategy: \`pnpm pack\` creates tarballs where workspace:* is replaced with`,
+        ` * real semver versions. We reference those tarballs via file: in package.json`,
+        ` * so pnpm install resolves everything in one shot.`,
+        ` *`,
+        ` * Run: pnpm run link:dev`,
+        ` * Note: Remove pnpm.overrides + file: entries from package.json before publishing.`,
+        ` */`,
+        `import { execSync }                                               from 'node:child_process';`,
+        `import { readFileSync, writeFileSync, mkdirSync, realpathSync }   from 'node:fs';`,
+        `import { resolve, join }                                          from 'node:path';`,
+        `import { tmpdir }                                                 from 'node:os';`,
+        `import { fileURLToPath }                                          from 'node:url';`,
+        ``,
+        `const root    = resolve(fileURLToPath(import.meta.url), '..', '..');`,
+        `const pkgPath = resolve(root, 'package.json');`,
+        `const packDir = join(tmpdir(), 'openibm-packs');`,
+        ``,
+        `mkdirSync(packDir, { recursive: true });`,
+        ``,
+        `// ── Locate globally linked monorepo packages ──────────────────────────────────`,
+        `const globalModules = execSync('pnpm root --global', { encoding: 'utf8' }).trim();`,
+        ``,
+        `const deps    = ['@openibm/driver', '@openibm/types'];`,
+        `const devDeps = ['@openibm/client'];`,
+        ``,
+        `// ── Pack each package into a tarball ─────────────────────────────────────────`,
+        `// pnpm pack replaces workspace:* with real semver — no npm registry needed`,
+        `const tarballs = {};`,
+        ``,
+        `for (const name of [...deps, ...devDeps]) {`,
+        `    const linkedPath = join(globalModules, name);`,
+        `    const realPath   = realpathSync(linkedPath);`,
+        `    const meta       = JSON.parse(readFileSync(join(realPath, 'package.json'), 'utf8'));`,
+        `    const tgzName    = meta.name.replace('@', '').replace('/', '-') + '-' + meta.version + '.tgz';`,
+        `    const tgzPath    = join(packDir, tgzName);`,
+        ``,
+        `    execSync(\`pnpm pack --pack-destination "\${packDir}"\`, { cwd: realPath, stdio: 'ignore' });`,
+        `    tarballs[name] = tgzPath;`,
+        `    console.log(\`  packed  \${name} → \${tgzPath}\`);`,
+        `}`,
+        ``,
+        `// ── Patch package.json ────────────────────────────────────────────────────────`,
+        `const pkg = JSON.parse(readFileSync(pkgPath, 'utf8'));`,
+        ``,
+        `for (const name of deps)    { if (pkg.dependencies?.[name])    pkg.dependencies[name]    = \`file:\${tarballs[name]}\`; }`,
+        `for (const name of devDeps) { if (pkg.devDependencies?.[name]) pkg.devDependencies[name] = \`file:\${tarballs[name]}\`; }`,
+        ``,
+        `// Overrides ensure transitive deps of @openibm/client also resolve locally`,
+        `pkg.pnpm ??= {};`,
+        `pkg.pnpm.overrides ??= {};`,
+        `for (const name of deps) { pkg.pnpm.overrides[name] = \`file:\${tarballs[name]}\`; }`,
+        ``,
+        `writeFileSync(pkgPath, JSON.stringify(pkg, null, 4) + '\\n');`,
+        `console.log('\\n  patched  package.json with local tarball references');`,
+        `console.log('  (remove pnpm.overrides + file: entries before publishing)\\n');`,
+        ``,
+        `// ── Install everything in one shot ────────────────────────────────────────────`,
+        `execSync('pnpm install', { stdio: 'inherit', cwd: root });`,
+        `console.log('\\n  ✓ Done.\\n');`,
+        ``,
+    ].join('\n');
+}
+/** Zod-based IBM i data-type validators — shared by basic + express templates */
+export function ibmiValidatorsTs() {
+    return [
+        `/**`,
+        ` * IBM i data-type validators for Zod.`,
+        ` *`,
+        ` * Usage:`,
+        ` *   import { ibmiChar, ibmiPackedDecimal, ibmiInt } from './ibmi-validators.js';`,
+        ` *`,
+        ` *   const schema = z.object({`,
+        ` *       name:    ibmiChar(8),             // CHAR(8)`,
+        ` *       balance: ibmiPackedDecimal(6, 2), // DECIMAL(6,2)`,
+        ` *       id:      ibmiInt,                 // INTEGER`,
+        ` *   });`,
+        ` */`,
+        `import { z } from 'zod';`,
+        ``,
+        `// ── String types ─────────────────────────────────────────────────────────────`,
+        ``,
+        `/** CHAR(n) — fixed-length string, max n characters (trailing spaces are trimmed by DB2) */`,
+        `export const ibmiChar = (n: number) =>`,
+        `    z.string().max(n, \`Must be at most \${n} characters (CHAR(\${n}))\`);`,
+        ``,
+        `/** VARCHAR(n) — variable-length string, max n characters */`,
+        `export const ibmiVarChar = (n: number) =>`,
+        `    z.string().max(n, \`Must be at most \${n} characters (VARCHAR(\${n}))\`);`,
+        ``,
+        `// ── Decimal types ────────────────────────────────────────────────────────────`,
+        ``,
+        `/**`,
+        ` * DECIMAL(precision, scale) — packed decimal / zoned decimal.`,
+        ` * e.g. ibmiPackedDecimal(9, 2) allows values from -9999999.99 to 9999999.99`,
+        ` */`,
+        `export const ibmiPackedDecimal = (precision: number, scale: number) => {`,
+        `    const intDigits = precision - scale;`,
+        `    const factor    = Math.pow(10, scale);`,
+        `    return z.number()`,
+        `        .refine(`,
+        `            v => Math.abs(v) < Math.pow(10, intDigits),`,
+        `            \`Integer part exceeds DECIMAL(\${precision},\${scale})\`,`,
+        `        )`,
+        `        .refine(`,
+        `            v => Number.isInteger(Math.round(v * factor)),`,
+        `            \`Max \${scale} decimal places for DECIMAL(\${precision},\${scale})\`,`,
+        `        );`,
+        `};`,
+        ``,
+        `/** NUMERIC(precision, scale) — alias for ibmiPackedDecimal */`,
+        `export const ibmiNumeric = ibmiPackedDecimal;`,
+        ``,
+        `// ── Integer types ────────────────────────────────────────────────────────────`,
+        ``,
+        `/** INTEGER — 4-byte signed integer */`,
+        `export const ibmiInt = z.number().int()`,
+        `    .min(-2_147_483_648, 'Underflows INTEGER')`,
+        `    .max( 2_147_483_647, 'Overflows INTEGER');`,
+        ``,
+        `/** SMALLINT — 2-byte signed integer */`,
+        `export const ibmiSmallInt = z.number().int()`,
+        `    .min(-32_768, 'Underflows SMALLINT')`,
+        `    .max( 32_767, 'Overflows SMALLINT');`,
+        ``,
+        `/** BIGINT — 8-byte signed integer (capped at JS safe integer range) */`,
+        `export const ibmiBigInt = z.number().int()`,
+        `    .min(-9_007_199_254_740_991, 'Underflows safe BIGINT range')`,
+        `    .max( 9_007_199_254_740_991, 'Overflows safe BIGINT range');`,
+        ``,
+        `// ── Date / time types ────────────────────────────────────────────────────────`,
+        ``,
+        `/** DATE — ISO date string YYYY-MM-DD */`,
+        `export const ibmiDate = z.string()`,
+        `    .regex(/^\\d{4}-\\d{2}-\\d{2}$/, 'Must be YYYY-MM-DD (IBM i DATE)');`,
+        ``,
+        `/** TIME — time string HH:MM:SS */`,
+        `export const ibmiTime = z.string()`,
+        `    .regex(/^\\d{2}:\\d{2}:\\d{2}$/, 'Must be HH:MM:SS (IBM i TIME)');`,
+        ``,
+        `/** TIMESTAMP — IBM i format YYYY-MM-DD-HH.MM.SS.ffffff */`,
+        `export const ibmiTimestamp = z.string()`,
+        `    .regex(`,
+        `        /^\\d{4}-\\d{2}-\\d{2}-\\d{2}\\.\\d{2}\\.\\d{2}\\.\\d{6}$/,`,
+        `        'Must be YYYY-MM-DD-HH.MM.SS.ffffff (IBM i TIMESTAMP)',`,
+        `    );`,
+        ``,
+    ].join('\n');
+}

package/dist/templates/express.d.ts

@@ -0,0 +1,2 @@
+import type { Answers, FileMap } from '../scaffold.js';
+export declare function expressFiles(a: Answers): FileMap;

package/dist/templates/express.js

@@ -0,0 +1,199 @@
+import { clientConfigBlock, ibmiValidatorsTs, linkDevScriptMjs } from './basic.js';
+export function expressFiles(a) {
+    const hasProgram = a.features.includes('program');
+    const hasTable = a.features.includes('table');
+    return {
+        'package.json': packageJson(a),
+        'tsconfig.json': tsconfig(),
+        'src/index.ts': indexTs(a, hasProgram, hasTable),
+        'src/ibmi-validators.ts': ibmiValidatorsTs(),
+        '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/index.ts',
+            start: 'node dist/index.js',
+            'link:dev': 'node scripts/link-dev.mjs',
+        },
+        dependencies: {
+            '@openibm/driver': '^0.1.0',
+            '@openibm/types': '^0.1.0',
+            express: '^4.21.0',
+            morgan: '^1.10.0',
+            'swagger-ui-express': '^5.0.0',
+            zod: '^3.23.0',
+            ...(a.transport === 'odbc' ? { odbc: '^2.4.0' } : {}),
+            ...(a.transport === 'ssh' ? { ssh2: '^1.15.0' } : {}),
+        },
+        devDependencies: {
+            '@openibm/client': '^0.1.0',
+            '@types/express': '^4.17.0',
+            '@types/morgan': '^1.9.0',
+            '@types/swagger-ui-express': '^4.1.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,
+            forceConsistentCasingInFileNames: true,
+        },
+        include: ['src'],
+        exclude: ['node_modules', 'dist'],
+    }, null, 4) + '\n';
+}
+// ── src/index.ts ──────────────────────────────────────────────────────────────
+function indexTs(a, hasProgram, hasTable) {
+    // ── Swagger paths (built conditionally) ──────────────────────────────────
+    const swaggerPaths = [
+        `        '/health': {`,
+        `            get: {`,
+        `                tags: ['Health'],`,
+        `                summary: 'Connection status',`,
+        `                responses: {`,
+        `                    '200': { description: 'OK', content: { 'application/json': { schema: { example: { status: 'ok', connected: true } } } } },`,
+        `                },`,
+        `            },`,
+        `        },`,
+    ];
+    if (hasTable) {
+        swaggerPaths.push(`        '/customers': {`, `            get: {`, `                tags: ['Customers'],`, `                summary: 'List customers (first 20, filtered by state)',`, `                parameters: [{`, `                    in: 'query', name: 'state', required: false,`, `                    schema: { type: 'string', maxLength: 2, example: 'TX' },`, `                    description: 'State code — CHAR(2)',`, `                }],`, `                responses: { '200': { description: 'Array of customer rows' } },`, `            },`, `        },`, `        '/customers/{id}': {`, `            get: {`, `                tags: ['Customers'],`, `                summary: 'Find customer by ID',`, `                parameters: [{`, `                    in: 'path', name: 'id', required: true,`, `                    schema: { type: 'integer', example: 1 },`, `                }],`, `                responses: {`, `                    '200': { description: 'Customer row' },`, `                    '404': { description: 'Not found' },`, `                },`, `            },`, `        },`);
+    }
+    if (hasProgram) {
+        swaggerPaths.push(`        '/calculate': {`, `            post: {`, `                tags: ['Programs'],`, `                summary: 'Call SimpleCalc IBM i program',`, `                requestBody: {`, `                    required: true,`, `                    content: {`, `                        'application/json': {`, `                            schema: {`, `                                type: 'object',`, `                                required: ['input'],`, `                                properties: { input: { type: 'integer', example: 5, description: 'IBM i INTEGER' } },`, `                            },`, `                        },`, `                    },`, `                },`, `                responses: {`, `                    '200': { description: 'Calculation result', content: { 'application/json': { schema: { example: { input: 5, output: 500 } } } } },`, `                    '400': { description: 'Validation error' },`, `                },`, `            },`, `        },`);
+    }
+    // ── Routes ───────────────────────────────────────────────────────────────
+    const routes = [
+        `// ── Health ───────────────────────────────────────────────────────────────────`,
+        ``,
+        `app.get('/health', (_req, res) => {`,
+        `    res.json({ status: 'ok', connected: client.isConnected() });`,
+        `});`,
+    ];
+    if (hasTable) {
+        routes.push(``, `// ── Customers ────────────────────────────────────────────────────────────────`, ``, `app.get('/customers', async (req, res) => {`, `    const state = typeof req.query.state === 'string' ? req.query.state : 'TX';`, `    const rows  = await client.query.Customer.findMany({`, `        where:   { state },`, `        orderBy: { customerId: 'asc' },`, `        take:    20,`, `    });`, `    res.json(rows);`, `});`, ``, `app.get('/customers/:id', async (req, res) => {`, `    const row = await client.query.Customer.findFirst({`, `        where: { customerId: Number(req.params.id) },`, `    });`, `    if (!row) { res.status(404).json({ error: 'Not found' }); return; }`, `    res.json(row);`, `});`);
+    }
+    if (hasProgram) {
+        routes.push(``, `// ── SimpleCalc ───────────────────────────────────────────────────────────────`, ``, `const calculateSchema = z.object({ input: ibmiInt });`, ``, `app.post('/calculate', async (req, res) => {`, `    const parsed = calculateSchema.safeParse(req.body);`, `    if (!parsed.success) {`, `        res.status(400).json({ errors: parsed.error.flatten() });`, `        return;`, `    }`, `    const result = await client.program.SimpleCalc({ input: parsed.data.input });`, `    res.json({ input: parsed.data.input, output: result.output });`, `});`);
+    }
+    const zodImports = hasProgram
+        ? [`import { z } from 'zod';`, `import { ibmiInt } from './ibmi-validators.js';`]
+        : [];
+    return [
+        `import express from 'express';`,
+        `import morgan from 'morgan';`,
+        `import swaggerUi from 'swagger-ui-express';`,
+        `import { createClient } from './generated/ibmi/index.js';`,
+        ...zodImports,
+        ``,
+        `const app  = express();`,
+        `const PORT = Number(process.env.PORT ?? 3000);`,
+        ``,
+        `// ── Middleware ────────────────────────────────────────────────────────────────`,
+        ``,
+        `app.use(express.json());`,
+        `app.use(morgan('dev'));`,
+        ``,
+        `// ── IBM i client ──────────────────────────────────────────────────────────────`,
+        ``,
+        clientConfigBlock(a),
+        ``,
+        `// ── OpenAPI / Swagger ─────────────────────────────────────────────────────────`,
+        ``,
+        `const apiSpec = {`,
+        `    openapi: '3.0.0',`,
+        `    info: { title: '${a.projectName}', version: '1.0.0', description: 'IBM i REST API' },`,
+        `    paths: {`,
+        ...swaggerPaths,
+        `    },`,
+        `};`,
+        ``,
+        `app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(apiSpec as any));`,
+        ``,
+        `// ── Routes ───────────────────────────────────────────────────────────────────`,
+        ``,
+        ...routes,
+        ``,
+        `// ── Start ────────────────────────────────────────────────────────────────────`,
+        ``,
+        `app.listen(PORT, async () => {`,
+        `    await client.connect();`,
+        `    console.log(\`Server:  http://localhost:\${PORT}\`);`,
+        `    console.log(\`Swagger: http://localhost:\${PORT}/api-docs\`);`,
+        `});`,
+        ``,
+    ].join('\n');
+}
+// ── README.md ─────────────────────────────────────────────────────────────────
+function readme(a, hasTable, hasProgram) {
+    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 Express 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`,
+        `\`\`\``,
+        ``,
+        `## Endpoints`,
+        ``,
+        `| Route | Description |`,
+        `|---|---|`,
+        ...endpoints,
+        ``,
+        `## IBM i validators`,
+        ``,
+        `\`src/ibmi-validators.ts\` provides Zod schemas for IBM i data types:`,
+        ``,
+        `\`\`\`ts`,
+        `import { ibmiChar, ibmiPackedDecimal, ibmiInt } from './ibmi-validators.js';`,
+        ``,
+        `const schema = z.object({`,
+        `    name:    ibmiChar(8),              // CHAR(8)`,
+        `    balance: ibmiPackedDecimal(6, 2),  // DECIMAL(6,2)`,
+        `    id:      ibmiInt,                  // INTEGER`,
+        `});`,
+        `\`\`\``,
+        ``,
+    ].join('\n');
+}

package/dist/templates/nestjs.d.ts

@@ -0,0 +1,2 @@
+import type { Answers, FileMap } from '../scaffold.js';
+export declare function nestjsFiles(a: Answers): FileMap;