create-forgeon 0.1.2 → 0.1.6

package/templates/docs-fragments/README/90_next_steps.md

@@ -1,7 +1,7 @@
-## Next Steps
-
-- Backend entrypoint: `apps/api/src/main.ts`
-- Frontend entrypoint: `apps/web/src/main.tsx`
-- Project docs index: `docs/README.md`
-- AI workflow docs: `docs/AI/*`
-- Module contract spec: `docs/AI/MODULE_SPEC.md`
+## Next Steps
+
+- Backend entrypoint: `apps/api/src/main.ts`
+- Frontend entrypoint: `apps/web/src/main.tsx`
+- Project docs index: `docs/README.md`
+- AI workflow docs: `docs/AI/*`
+- Module contract spec: `docs/AI/MODULE_SPEC.md`

package/templates/module-fragments/i18n/00_title.md

@@ -0,0 +1,5 @@
+# {{MODULE_LABEL}}
+
+- Id: `{{MODULE_ID}}`
+- Category: `{{MODULE_CATEGORY}}`
+- Status: {{MODULE_STATUS}}

package/templates/module-fragments/i18n/10_overview.md

@@ -0,0 +1,9 @@
+## Overview
+
+Adds optional i18n support across backend and frontend.
+
+Included parts:
+- `@forgeon/i18n` (NestJS i18n integration package)
+- `@forgeon/i18n-contracts` (shared locale/query constants)
+- `@forgeon/i18n-web` (React-side locale helpers)
+- `resources/i18n/*` dictionaries (`en`, `uk`)

package/templates/module-fragments/i18n/20_scope.md

@@ -0,0 +1,7 @@
+## Applied Scope
+
+- API module wiring (`AppModule`, config, filter, health endpoint translation)
+- API package/deps/scripts updates
+- Docker env + compose i18n env keys
+- Frontend language selector in `apps/web/src/App.tsx`
+- Frontend package/deps/scripts updates for i18n helpers

package/templates/module-fragments/i18n/90_status_implemented.md

@@ -0,0 +1,3 @@
+## Status
+
+Implemented and applied by `create-forgeon add i18n`.

package/templates/module-fragments/jwt-auth/00_title.md

@@ -1 +1 @@
-# MODULE: {{MODULE_LABEL}}
+# MODULE: {{MODULE_LABEL}}

package/templates/module-fragments/jwt-auth/10_overview.md

@@ -1,6 +1,6 @@
-## Overview
-
-- Id: `{{MODULE_ID}}`
-- Category: `{{MODULE_CATEGORY}}`
-- Status: {{MODULE_STATUS}}
-- Description: {{MODULE_DESCRIPTION}}
+## Overview
+
+- Id: `{{MODULE_ID}}`
+- Category: `{{MODULE_CATEGORY}}`
+- Status: {{MODULE_STATUS}}
+- Description: {{MODULE_DESCRIPTION}}

package/templates/module-fragments/jwt-auth/20_scope.md

@@ -1,7 +1,7 @@
-## Scope (Planned)
-
-Planned implementation target:
-
-1. Add reusable auth package wiring under `packages/*`.
-2. Add NestJS guard + strategy integration in `apps/api`.
-3. Add env docs and usage examples.
+## Scope (Planned)
+
+Planned implementation target:
+
+1. Add reusable auth package wiring under `packages/*`.
+2. Add NestJS guard + strategy integration in `apps/api`.
+3. Add env docs and usage examples.

package/templates/module-fragments/jwt-auth/90_status_planned.md

@@ -1,3 +1,3 @@
-## Current State
-
-This module is registered but not implemented yet.
+## Current State
+
+This module is registered but not implemented yet.

package/templates/module-fragments/queue/00_title.md

@@ -1 +1 @@
-# MODULE: {{MODULE_LABEL}}
+# MODULE: {{MODULE_LABEL}}

package/templates/module-fragments/queue/10_overview.md

@@ -1,6 +1,6 @@
-## Overview
-
-- Id: `{{MODULE_ID}}`
-- Category: `{{MODULE_CATEGORY}}`
-- Status: {{MODULE_STATUS}}
-- Description: {{MODULE_DESCRIPTION}}
+## Overview
+
+- Id: `{{MODULE_ID}}`
+- Category: `{{MODULE_CATEGORY}}`
+- Status: {{MODULE_STATUS}}
+- Description: {{MODULE_DESCRIPTION}}

package/templates/module-fragments/queue/20_scope.md

@@ -1,7 +1,7 @@
-## Scope (Planned)
-
-Planned implementation target:
-
-1. Add queue package preset (worker + producer abstractions).
-2. Wire module imports and config in `apps/api`.
-3. Document runtime and deployment notes.
+## Scope (Planned)
+
+Planned implementation target:
+
+1. Add queue package preset (worker + producer abstractions).
+2. Wire module imports and config in `apps/api`.
+3. Document runtime and deployment notes.

package/templates/module-fragments/queue/90_status_planned.md

@@ -1,3 +1,3 @@
-## Current State
-
-This module is registered but not implemented yet.
+## Current State
+
+This module is registered but not implemented yet.

package/templates/module-presets/i18n/apps/web/src/App.tsx

@@ -0,0 +1,61 @@
+import { useState } from 'react';
+import * as i18nWeb from '@forgeon/i18n-web';
+import type { I18nLocale } from '@forgeon/i18n-web';
+import './styles.css';
+
+type HealthResponse = {
+  status: string;
+  message: string;
+};
+
+export default function App() {
+  const { I18N_LOCALES, getInitialLocale, persistLocale, toLangQuery } = i18nWeb;
+  const [locale, setLocale] = useState<I18nLocale>(getInitialLocale);
+  const [data, setData] = useState<HealthResponse | null>(null);
+  const [error, setError] = useState<string | null>(null);
+
+  const changeLocale = (nextLocale: I18nLocale) => {
+    setLocale(nextLocale);
+    persistLocale(nextLocale);
+  };
+
+  const checkApi = async () => {
+    setError(null);
+    try {
+      const response = await fetch(`/api/health${toLangQuery(locale)}`, {
+        headers: {
+          'Accept-Language': locale,
+        },
+      });
+      if (!response.ok) {
+        throw new Error(`HTTP ${response.status}`);
+      }
+      const payload = (await response.json()) as HealthResponse;
+      setData(payload);
+    } catch (err) {
+      setError(err instanceof Error ? err.message : 'Unknown error');
+    }
+  };
+
+  return (
+    <main className="page">
+      <h1>Forgeon Fullstack Scaffold</h1>
+      <p>Default frontend preset: React + Vite + TypeScript.</p>
+      <label htmlFor="language">Language:</label>
+      <select
+        id="language"
+        value={locale}
+        onChange={(event) => changeLocale(event.target.value as I18nLocale)}
+      >
+        {I18N_LOCALES.map((item) => (
+          <option key={item} value={item}>
+            {item}
+          </option>
+        ))}
+      </select>
+      <button onClick={checkApi}>Check API health</button>
+      {data ? <pre>{JSON.stringify(data, null, 2)}</pre> : null}
+      {error ? <p className="error">{error}</p> : null}
+    </main>
+  );
+}

package/templates/module-presets/i18n/packages/i18n-contracts/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@forgeon/i18n-contracts",
+  "version": "0.1.0",
+  "private": true,
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.7",
+    "typescript": "^5.7.3"
+  }
+}

package/templates/module-presets/i18n/packages/i18n-contracts/src/index.ts

@@ -0,0 +1,7 @@
+export const I18N_LOCALES = ['en', 'uk'] as const;
+
+export type I18nLocale = (typeof I18N_LOCALES)[number];
+
+export const I18N_DEFAULT_LANG: I18nLocale = 'en';
+export const I18N_FALLBACK_LANG: I18nLocale = 'en';
+export const LANG_QUERY_PARAM = 'lang';

package/templates/module-presets/i18n/packages/i18n-contracts/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*.ts"]
+}

package/templates/module-presets/i18n/packages/i18n-web/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@forgeon/i18n-web",
+  "version": "0.1.0",
+  "private": true,
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "dependencies": {
+    "@forgeon/i18n-contracts": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.7",
+    "typescript": "^5.7.3"
+  }
+}

package/templates/module-presets/i18n/packages/i18n-web/src/index.ts

@@ -0,0 +1,50 @@
+import {
+  I18N_DEFAULT_LANG,
+  I18N_LOCALES,
+  LANG_QUERY_PARAM,
+  type I18nLocale,
+} from '@forgeon/i18n-contracts';
+
+const LOCALE_STORAGE_KEY = 'forgeon.locale';
+
+type StorageLike = {
+  getItem: (key: string) => string | null;
+  setItem: (key: string, value: string) => void;
+};
+
+function getStorage(): StorageLike | undefined {
+  if (typeof globalThis !== 'object' || globalThis === null) {
+    return undefined;
+  }
+
+  const candidate = (globalThis as { localStorage?: StorageLike }).localStorage;
+  if (!candidate || typeof candidate.getItem !== 'function' || typeof candidate.setItem !== 'function') {
+    return undefined;
+  }
+
+  return candidate;
+}
+
+function isSupportedLocale(value: string): value is I18nLocale {
+  return I18N_LOCALES.includes(value as I18nLocale);
+}
+
+export function getInitialLocale(): I18nLocale {
+  const storage = getStorage();
+  const stored = storage?.getItem(LOCALE_STORAGE_KEY);
+  if (stored && isSupportedLocale(stored)) {
+    return stored;
+  }
+  return I18N_DEFAULT_LANG;
+}
+
+export function persistLocale(locale: I18nLocale): void {
+  const storage = getStorage();
+  storage?.setItem(LOCALE_STORAGE_KEY, locale);
+}
+
+export function toLangQuery(locale: I18nLocale): string {
+  return `?${LANG_QUERY_PARAM}=${encodeURIComponent(locale)}`;
+}
+
+export { I18N_LOCALES, type I18nLocale };

package/templates/module-presets/i18n/packages/i18n-web/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*.ts"]
+}