bank20baht-cli 0.6.0 → 0.7.0

package/templates/deploy/deploy/nginx.conf.hbs

@@ -0,0 +1,67 @@
+# {{project}}: the web apps and their API behind one origin.
+#
+#   /                          the host ({{host}})
+#   /remotes/<app>/            each remote, loaded by the host over Native Federation
+#   /federation.manifest.json  which remotes exist; edit it to add or repoint one, no rebuild
+#   /api/                      the Elysia server
+#
+# Installed as /etc/nginx/sites-available/{{project}} by deploy/install.sh.
+
+upstream {{project}}_api {
+    server 127.0.0.1:{{apiPort}};
+    keepalive 16;
+}
+
+server {
+    listen 80 default_server;
+    listen [::]:80 default_server;
+    server_name _;
+
+    root /var/www/{{project}}/{{host}};
+    index index.html;
+
+    gzip on;
+    gzip_types text/css application/javascript application/json image/svg+xml;
+
+    client_max_body_size 1m;
+
+    location = /federation.manifest.json {
+        alias /etc/{{project}}/federation.manifest.json;
+        add_header Cache-Control no-store;
+        # Repeated in every location that sets a header: nginx drops the inherited ones there.
+        add_header X-Content-Type-Options nosniff always;
+        add_header X-Frame-Options SAMEORIGIN always;
+        add_header Referrer-Policy same-origin always;
+    }
+
+    # Entry points are re-checked on every load, so a new release shows up at once; the hashed
+    # chunks they point to never change and may be kept.
+    location /remotes/ {
+        root /var/www/{{project}};
+        try_files $uri =404;
+        add_header Cache-Control no-cache;
+        add_header X-Content-Type-Options nosniff always;
+        add_header X-Frame-Options SAMEORIGIN always;
+        add_header Referrer-Policy same-origin always;
+    }
+
+    location /api/ {
+        proxy_pass http://{{project}}_api;
+        proxy_http_version 1.1;
+        proxy_set_header Connection "";
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+        add_header X-Content-Type-Options nosniff always;
+    }
+
+    # The host is a single-page app: any other path is its router's business.
+    location / {
+        try_files $uri $uri/ /index.html;
+        add_header Cache-Control no-cache;
+        add_header X-Content-Type-Options nosniff always;
+        add_header X-Frame-Options SAMEORIGIN always;
+        add_header Referrer-Policy same-origin always;
+    }
+}

package/templates/deploy/scripts/deploy.ts.hbs

@@ -0,0 +1,33 @@
+/**
+ * `bun run deploy root@host` builds a release, copies it to the machine and installs it
+ * (deploy/install.sh: nginx, bun and the {{project}} user on the first run; the files and a
+ * restart on every run). The target is a Debian or Ubuntu machine you can SSH into as root.
+ * Pass `--no-build` to ship the `.release/` that is already there.
+ */
+import { RELEASE, buildRelease } from './release.ts'
+
+const args = process.argv.slice(2)
+const target = args.find((arg) => !arg.startsWith('--'))
+if (target === undefined) {
+  console.error('usage: bun run deploy <user@host> [--no-build]')
+  process.exit(1)
+}
+
+const run = (command: string[]): void => {
+  console.log(`\x1b[36m$\x1b[0m ${command.join(' ')}`)
+  const result = Bun.spawnSync(command, { stdio: ['inherit', 'inherit', 'inherit'] })
+  if (result.exitCode !== 0) process.exit(result.exitCode)
+}
+
+if (!args.includes('--no-build')) buildRelease()
+
+const REMOTE_DIR = '/opt/{{project}}-release'
+// tar over ssh: the target needs nothing installed yet, not even rsync. Without macOS's extended
+// attributes, which GNU tar on the other side only warns about.
+run([
+  'sh',
+  '-c',
+  `COPYFILE_DISABLE=1 tar --no-xattrs -czf - -C ${RELEASE} . | ssh ${target} 'rm -rf ${REMOTE_DIR} && mkdir -p ${REMOTE_DIR} && tar -xzf - -C ${REMOTE_DIR}'`,
+])
+run(['ssh', target, `sh ${REMOTE_DIR}/install.sh`])
+console.log(`deployed: http://${target.split('@').pop() ?? target}/`)

package/templates/deploy/scripts/preview.ts.hbs

@@ -0,0 +1,57 @@
+/**
+ * `bun run preview` serves `.release/` the way deploy/nginx.conf does, on http://localhost:8080,
+ * with the API server started beside it: the production layout without a web server to install.
+ * Run `bun run release` first.
+ */
+import { existsSync } from 'node:fs'
+import { join } from 'node:path'
+
+import { RELEASE } from './release.ts'
+
+const PORT = 8080
+const API_PORT = 3019
+const API = `http://127.0.0.1:${String(API_PORT)}`
+const WWW = join(RELEASE, 'www')
+
+if (!existsSync(join(WWW, '{{host}}/index.html'))) {
+  console.error(`no ${RELEASE}/ yet: run \`bun run release\` first`)
+  process.exit(1)
+}
+
+const api = Bun.spawn(['bun', join(RELEASE, 'server/index.js')], {
+  env: { ...process.env, PORT: String(API_PORT) },
+  stdio: ['ignore', 'inherit', 'inherit'],
+})
+process.on('SIGINT', () => {
+  api.kill()
+  process.exit(0)
+})
+
+const file = async (path: string, cache: string): Promise<Response | undefined> => {
+  const found = Bun.file(path)
+  return (await found.exists())
+    ? new Response(found, { headers: { 'cache-control': cache } })
+    : undefined
+}
+
+const notFound = () => new Response('', { status: 404 })
+
+Bun.serve({
+  port: PORT,
+  async fetch(request) {
+    const url = new URL(request.url)
+    const path = decodeURIComponent(url.pathname)
+    if (path.startsWith('/api/')) return fetch(new Request(`${API}${path}${url.search}`, request))
+    if (path.includes('..')) return new Response('bad path', { status: 400 })
+    if (path === '/federation.manifest.json') {
+      return (await file(join(RELEASE, 'federation.manifest.json'), 'no-store')) ?? notFound()
+    }
+    if (path.startsWith('/remotes/')) return (await file(join(WWW, path), 'no-cache')) ?? notFound()
+    return (
+      (path === '/' ? undefined : await file(join(WWW, '{{host}}', path), 'no-cache')) ??
+      (await file(join(WWW, '{{host}}/index.html'), 'no-cache')) ??
+      notFound()
+    )
+  },
+})
+console.log(`preview on http://localhost:${String(PORT)} (api on ${API})`)

package/templates/deploy/scripts/release.ts.hbs

@@ -0,0 +1,48 @@
+/**
+ * `bun run release` builds everything and lays it out the way the web server serves it, in
+ * `.release/`:
+ *
+ *   server/index.js            the API, one bundled file
+ *   www/{{host}}/                 the host
+ *   www/remotes/<app>/         each remote in the host's federation manifest
+ *   federation.manifest.json   which remotes the host loads (installed once, then edited there)
+ *   nginx.conf {{project}}.service env.example install.sh
+ *
+ * `scripts/deploy.ts` ships that folder; `scripts/preview.ts` serves it locally.
+ */
+import { cpSync, mkdirSync, readFileSync, rmSync } from 'node:fs'
+import { join } from 'node:path'
+
+export const RELEASE = '.release'
+const HOST = 'apps/{{host}}'
+const MANIFEST = join(HOST, 'public/federation.manifest.json')
+
+const run = (command: string[]): void => {
+  console.log(`\x1b[36m$\x1b[0m ${command.join(' ')}`)
+  const result = Bun.spawnSync(command, { stdio: ['inherit', 'inherit', 'inherit'] })
+  if (result.exitCode !== 0) process.exit(result.exitCode)
+}
+
+export const buildRelease = (): void => {
+  run(['bun', 'run', 'build'])
+
+  rmSync(RELEASE, { recursive: true, force: true })
+  mkdirSync(join(RELEASE, 'www/remotes'), { recursive: true })
+  mkdirSync(join(RELEASE, 'server'), { recursive: true })
+
+  cpSync('apps/server/dist/index.js', join(RELEASE, 'server/index.js'))
+  cpSync(join(HOST, 'dist/{{host}}/browser'), join(RELEASE, 'www/{{host}}'), { recursive: true })
+  const remotes = Object.keys(JSON.parse(readFileSync(MANIFEST, 'utf8')) as Record<string, unknown>)
+  for (const app of remotes) {
+    cpSync(`apps/${app}/dist/${app}/browser`, join(RELEASE, 'www/remotes', app), {
+      recursive: true,
+    })
+  }
+  cpSync(MANIFEST, join(RELEASE, 'federation.manifest.json'))
+  for (const file of ['nginx.conf', '{{project}}.service', 'env.example', 'install.sh']) {
+    cpSync(join('deploy', file), join(RELEASE, file))
+  }
+  console.log(`release ready in ${RELEASE}/`)
+}
+
+if (import.meta.main) buildRelease()

package/templates/new/_gitignore

@@ -1,6 +1,9 @@
 node_modules
 .zvec-grep
 dist
+coverage
+*.tsbuildinfo
+.angular
 .env
 .env.*
 !.env.example

package/templates/new/_prettierignore

@@ -2,3 +2,4 @@ node_modules
 dist
 bun.lock
 coverage
+.angular

package/templates/new/package.json.hbs

@@ -15,7 +15,7 @@
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "knip": "knip",
-    "madge": "madge --circular --extensions ts,tsx apps packages scripts",
+    "madge": "madge --circular --extensions ts,tsx --exclude '(^|/)(dist|node_modules|\\.angular)/' apps packages scripts",
     "deps": "depcruise apps packages scripts --config .dependency-cruiser.mjs",
     "dup": "jscpd",
     "audit": "bun audit --audit-level=high",
@@ -33,7 +33,7 @@
     "@eslint/css": "^2.0.0",
     "@eslint/js": "^10.0.1",
     "@types/bun": "^1.3.0",
-    "bank20baht-strict": "0.0.5",
+    "bank20baht-strict": "0.0.6",
     "dependency-cruiser": "^18.3.1",
     "eslint": "^10.10.0",
     "eslint-config-prettier": "^10.1.8",

package/templates/remote/_editorconfig

@@ -0,0 +1,17 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.ts]
+quote_type = single
+ij_typescript_use_double_quotes = false
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

package/templates/remote/angular.json.hbs

@@ -0,0 +1,95 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "cli": {
+    "packageManager": "bun"
+  },
+  "newProjectRoot": "projects",
+  "projects": {
+    "{{app}}": {
+      "projectType": "application",
+      "schematics": {},
+      "root": "",
+      "sourceRoot": "src",
+      "prefix": "{{name}}",
+      "architect": {
+        "build": {
+          "builder": "@angular-architects/native-federation:build",
+          "options": {
+            "cacheExternalArtifacts": true,
+            "tsConfig": "tsconfig.federation.json"
+          },
+          "configurations": {
+            "production": {
+              "target": "{{app}}:esbuild:production"
+            },
+            "development": {
+              "target": "{{app}}:esbuild:development",
+              "dev": true
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "serve": {
+          "builder": "@angular-architects/native-federation:build",
+          "options": {
+            "target": "{{app}}:serve-original:development",
+            "tsConfig": "tsconfig.federation.json",
+            "rebuildDelay": 500,
+            "cacheExternalArtifacts": true,
+            "dev": true,
+            "devServer": true,
+            "port": 0
+          }
+        },
+        "esbuild": {
+          "builder": "@angular/build:application",
+          "options": {
+            "browser": "src/main.ts",
+            "tsConfig": "tsconfig.app.json",
+            "styles": [],
+            "polyfills": ["es-module-shims"]
+          },
+          "configurations": {
+            "production": {
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "500kB",
+                  "maximumError": "1MB"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "4kB",
+                  "maximumError": "8kB"
+                }
+              ],
+              "outputHashing": "all"
+            },
+            "development": {
+              "optimization": false,
+              "extractLicenses": false,
+              "sourceMap": true
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "serve-original": {
+          "builder": "@angular/build:dev-server",
+          "configurations": {
+            "production": {
+              "buildTarget": "{{app}}:esbuild:production"
+            },
+            "development": {
+              "buildTarget": "{{app}}:esbuild:development"
+            }
+          },
+          "defaultConfiguration": "development",
+          "options": {
+            "port": {{port}}
+          }
+        }
+      }
+    }
+  }
+}

package/templates/remote/federation.config.mjs.hbs

@@ -0,0 +1,48 @@
+import { withNativeFederation, fromPackageJson } from '@angular-architects/native-federation/config'
+
+export default withNativeFederation({
+  name: '{{app}}',
+
+  shared: fromPackageJson({
+    singleton: true,
+    strictVersion: true,
+    requiredVersion: 'auto',
+    build: 'package',
+  })
+    // includeSecondaries is an opt-out of ignoreUnusedDeps, so all of
+    // @angular/core is shared to prevent mismatches.
+    .patch(['@angular/core'], { includeSecondaries: { keepAll: true } })
+    // Same for bank20baht-ui: the host and the remotes may import different entry
+    // points of it. Unshared, each side bundles its own copy of the elements and
+    // the second customElements.define('baht-button') throws.
+    .patch(['bank20baht-ui'], { includeSecondaries: { keepAll: true } }),
+
+  skip: [
+    'rxjs/ajax',
+    'rxjs/fetch',
+    'rxjs/testing',
+    'rxjs/webSocket',
+    // Server / React entry points of bank20baht-ui (pulled in by keepAll above).
+    'bank20baht-ui/ssr',
+    'bank20baht-ui/hydrate',
+    'bank20baht-ui/react',
+    // marked's command-line entry imports Node built-ins.
+    /^marked\/bin/,
+  ],
+
+  // The kit (a tsconfig path into packages/kit) is compiled into each app, not shared.
+  sharedMappings: [],
+
+  exposes: {
+    './Routes': './src/app/{{name}}.routes.ts',
+  },
+
+  features: {
+    // Off: the unused-dependency scan (sheriff) refuses sources outside the app folder, and
+    // the kit lives in packages/kit. Every package.json dependency is shared instead, so each
+    // app lists bank20baht-ui's optional peers (marked, dompurify, flatpickr) itself.
+    ignoreUnusedDeps: false,
+    // Groups chunks in remoteEntry.json for a smaller metadata file.
+    denseChunking: true,
+  },
+})

package/templates/remote/package.json.hbs

@@ -0,0 +1,37 @@
+{
+  "name": "{{app}}",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "ng": "ng",
+    "dev": "ng serve",
+    "build": "ng build",
+    "typecheck": "tsc -b --noEmit",
+    "pretypecheck": "bun run --filter server build:types",
+    "prebuild": "bun run --filter server build:types"
+  },
+  "dependencies": {
+    "@angular-architects/native-federation": "^22.2.1",
+    "@angular/common": "^22.2.0",
+    "@angular/compiler": "^22.2.0",
+    "@angular/core": "^22.2.0",
+    "@angular/platform-browser": "^22.2.0",
+    "@angular/router": "^22.2.0",
+    "bank20baht-ui": "0.19.0",
+    "bank20baht-ui-angular": "0.2.0",
+    "dompurify": "3.4.17",
+    "es-module-shims": "^2.8.0",
+    "flatpickr": "4.6.13",
+    "marked": "18.1.3",
+    "ngx-eden": "^0.2.0",
+    "rxjs": "~7.8.0",
+    "tslib": "^2.3.0"
+  },
+  "devDependencies": {
+    "@angular/build": "^22.2.0",
+    "@angular/cli": "^22.2.0",
+    "@angular/compiler-cli": "^22.2.0",
+    "@softarc/native-federation-orchestrator": "^4.6.0",
+    "typescript": "~6.0.2"
+  }
+}

package/templates/remote/src/app/__name__.routes.ts.hbs

@@ -0,0 +1,12 @@
+import type { Routes } from '@angular/router'
+
+import { {{pascal}}Component } from './modules/{{name}}/{{name}}.component'
+
+/** What the host mounts under `/{{name}}` (exposed as `./Routes`). */
+export const routes: Routes = [
+  {
+    path: '',
+    title: '{{title}}',
+    component: {{pascal}}Component,
+  },
+]

package/templates/remote/src/app/modules/__name__/__name__.component.ts.hbs

@@ -0,0 +1,37 @@
+import { ChangeDetectionStrategy, Component, inject } from '@angular/core'
+import { describeError } from '@{{project}}/kit'
+import { BAHT_UI } from 'bank20baht-ui-angular'
+import { {{pascal}}Service } from '../../services/{{name}}.service'
+
+/** The {{title}} page: what the server says at `GET /api/hello`. */
+@Component({
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  imports: [BAHT_UI],
+  selector: '{{name}}-page',
+  template: `
+    <div class="app-page">
+      <baht-page-header
+        heading="{{title}}"
+        description="A remote, loaded by the host at runtime."
+      ></baht-page-header>
+      <baht-card heading="From the server">
+        @if (hello.error(); as error) {
+          <baht-error-state
+            heading="The server did not answer"
+            [message]="describeError(error)"
+            retry-label="Try again"
+            (bahtRetry)="hello.reload()"
+          ></baht-error-state>
+        } @else if (hello.value(); as body) {
+          <p [textContent]="body.message"></p>
+        } @else {
+          <baht-skeleton variant="text"></baht-skeleton>
+        }
+      </baht-card>
+    </div>
+  `,
+})
+export class {{pascal}}Component {
+  protected readonly hello = inject({{pascal}}Service).hello()
+  protected readonly describeError = describeError
+}

package/templates/remote/src/app/services/__name__.service.ts.hbs

@@ -0,0 +1,14 @@
+import { Injectable, inject } from '@angular/core'
+import { Api } from '@{{project}}/kit'
+import { edenResource } from 'ngx-eden'
+
+/** Everything the {{title}} pages ask the server. */
+@Injectable({ providedIn: 'root' })
+export class {{pascal}}Service {
+  private readonly api = inject(Api).client.api
+
+  /** `GET /api/hello` as a resource; create it in an injection context (a field initializer). */
+  hello() {
+    return edenResource(() => this.api.hello.get.$request())
+  }
+}

package/templates/remote/src/index.html.hbs

@@ -0,0 +1,11 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>{{app}} (remote)</title>
+    <meta name="robots" content="noindex" />
+  </head>
+  <body>
+    <p>{{app}} is a Native Federation remote. Open it through the host.</p>
+  </body>
+</html>

package/templates/remote/src/main.ts.hbs

@@ -0,0 +1,3 @@
+// {{app}} is a Native Federation remote only: the host loads ./Routes from its
+// remoteEntry.json. Nothing boots on this origin; index.html just says so.
+export {}

package/templates/remote/tsconfig.app.json

@@ -0,0 +1,10 @@
+/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
+/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "types": []
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["src/**/*.spec.ts"]
+}

package/templates/remote/tsconfig.federation.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.app.json",
+  "include": ["src/**/*.d.ts"]
+}

package/templates/remote/tsconfig.json.hbs

@@ -0,0 +1,36 @@
+/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
+/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "verbatimModuleSyntax": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "skipLibCheck": true,
+    "isolatedModules": true,
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "target": "ES2022",
+    "module": "preserve",
+    "paths": {
+      "@{{project}}/kit": ["../../packages/kit/src/index.ts"]
+    }
+  },
+  "angularCompilerOptions": {
+    "enableI18nLegacyMessageIdFormat": false,
+    "strictInjectionParameters": true,
+    "strictTemplates": true,
+    "strictInputAccessModifiers": true
+  },
+  "files": [],
+  "references": [
+    {
+      "path": "./tsconfig.app.json"
+    }
+  ]
+}