@effijs/templates 0.0.0-stage → 1.0.0-alpha.1

package/lib/patch.js

@@ -0,0 +1,62 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { createRequire } from 'node:module';
+
+export function isPlainData(value) {
+  if (value == null) return true;
+  const kind = typeof value;
+  if (kind === 'function' || kind === 'symbol' || kind === 'bigint') return false;
+  if (kind !== 'object') return true;
+  if (Array.isArray(value)) return value.every(isPlainData);
+  const proto = Object.getPrototypeOf(value);
+  if (proto !== Object.prototype && proto !== null) return false;
+  return Object.values(value).every(isPlainData);
+}
+
+export function requireCjs(file) {
+  const absolute = path.resolve(file);
+  const require = createRequire(absolute);
+  delete require.cache[absolute];
+  return require(absolute);
+}
+
+export function stamp() {
+  return new Date().toISOString().replace(/[:.]/g, '-');
+}
+
+export async function backupFile(root, file) {
+  if (!fs.existsSync(file)) return null;
+  const relative = path.relative(root, file);
+  const dest = path.join(root, '.forge/backup', stamp(), relative);
+  await fs.promises.mkdir(path.dirname(dest), { recursive: true });
+  await fs.promises.copyFile(file, dest);
+  return dest;
+}
+
+export async function readTextIfExists(file) {
+  if (!fs.existsSync(file)) return null;
+  return fs.promises.readFile(file, 'utf8');
+}
+
+export async function applyTextPatch(root, file, transform, { dryRun = false } = {}) {
+  const backup = dryRun ? null : await backupFile(root, file);
+  const existed = fs.existsSync(file);
+  const current = existed ? await fs.promises.readFile(file, 'utf8') : '';
+  const result = await transform(current, { exists: existed });
+  if (!result?.ok) {
+    return {
+      ok: false,
+      file,
+      backup,
+      reason: result?.reason ?? 'Patch failed',
+      manual: result?.manual,
+    };
+  }
+  if (result.content === current) {
+    return { ok: true, file, backup, unchanged: true };
+  }
+  if (dryRun) return { ok: true, file, dryRun: true, backup };
+  await fs.promises.mkdir(path.dirname(file), { recursive: true });
+  await fs.promises.writeFile(file, result.content);
+  return { ok: true, file, backup, changed: true };
+}

package/lib/paths.js

@@ -0,0 +1,12 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const libDir = path.dirname(fileURLToPath(import.meta.url));
+
+export function packageRoot() {
+  return path.resolve(libDir, '..');
+}
+
+export function platformRoot(id = 'react-native') {
+  return path.join(packageRoot(), 'platforms', id);
+}

package/lib/project.js

@@ -0,0 +1,48 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+export function readJson(file) {
+  return JSON.parse(fs.readFileSync(file, 'utf8'));
+}
+
+export function readPackageJson(root) {
+  const file = path.join(root, 'package.json');
+  if (!fs.existsSync(file)) return null;
+  return readJson(file);
+}
+
+export function detectPackageManager(root) {
+  if (fs.existsSync(path.join(root, 'pnpm-lock.yaml'))) return 'pnpm';
+  if (fs.existsSync(path.join(root, 'yarn.lock'))) return 'yarn';
+  if (fs.existsSync(path.join(root, 'package-lock.json'))) return 'npm';
+  return 'yarn';
+}
+
+export function detectReactNativeVersion(root) {
+  const pkg = readPackageJson(root);
+  const version = pkg?.dependencies?.['react-native'] ?? pkg?.devDependencies?.['react-native'];
+  if (!version) return null;
+  const match = String(version).match(/(\d+\.\d+\.\d+)/);
+  return match ? match[1] : String(version).replace(/^[^\d]*/, '');
+}
+
+export function detectNavigator(root) {
+  const pkg = readPackageJson(root);
+  const deps = { ...pkg?.dependencies, ...pkg?.devDependencies };
+  if (deps?.['expo-router']) return 'expo-router';
+  if (deps?.['@react-navigation/native']) return 'react-navigation';
+  if (deps?.['react-native-navigation']) return 'react-native-navigation';
+  return null;
+}
+
+export function projectRoot(forge) {
+  return forge?.paths?.root ?? process.cwd();
+}
+
+export function listDirs(dir) {
+  if (!fs.existsSync(dir)) return [];
+  return fs
+    .readdirSync(dir, { withFileTypes: true })
+    .filter((entry) => entry.isDirectory())
+    .map((entry) => entry.name);
+}

package/lib/registry.js

@@ -0,0 +1,99 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+
+import { readState } from './journal.js';
+
+const REQUIRED = [
+  'id',
+  'type',
+  'platforms',
+  'title',
+  'description',
+  'status',
+  'since',
+  'tags',
+  'requires',
+  'dependencies',
+  'files',
+  'register',
+  'manual',
+];
+
+export function validateSolution(solution, file) {
+  const missing = REQUIRED.filter((key) => solution[key] === undefined);
+  if (missing.length) {
+    throw new Error(`${file} is missing fields: ${missing.join(', ')}`);
+  }
+  if (!['component', 'service', 'util'].includes(solution.type)) {
+    throw new Error(`${file} has unknown type ${solution.type}`);
+  }
+  if (!['stable', 'experimental', 'stub'].includes(solution.status)) {
+    throw new Error(`${file} has unknown status ${solution.status}`);
+  }
+}
+
+export async function loadSolutions(packageRoot) {
+  const roots = [
+    path.join(packageRoot, 'platforms'),
+    path.join(packageRoot, 'shared/solutions'),
+  ];
+  const files = [];
+  for (const root of roots) {
+    if (!fs.existsSync(root)) continue;
+    walk(root, files);
+  }
+  const solutions = [];
+  for (const file of files) {
+    const mod = await import(pathToFileURL(file).href);
+    const solution = mod.default ?? mod;
+    validateSolution(solution, file);
+    solutions.push({ ...solution, _dir: path.dirname(file), _file: file });
+  }
+  return solutions;
+}
+
+function walk(dir, files) {
+  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    const next = path.join(dir, entry.name);
+    if (entry.isDirectory()) walk(next, files);
+    else if (entry.name === 'solution.js') files.push(next);
+  }
+}
+
+export function filterByPlatform(solutions, platform) {
+  return solutions.filter((solution) => solution.platforms.includes(platform));
+}
+
+export function byId(solutions) {
+  return new Map(solutions.map((solution) => [solution.id, solution]));
+}
+
+export function expandRequires(ids, solutions) {
+  const map = byId(solutions);
+  const selected = [];
+  const seen = new Set();
+  const visit = (id) => {
+    if (seen.has(id)) return;
+    const solution = map.get(id);
+    if (!solution) throw new Error(`Unknown solution "${id}"`);
+    seen.add(id);
+    for (const req of solution.requires ?? []) visit(req);
+    selected.push(solution);
+  };
+  for (const id of ids) visit(id);
+  return selected;
+}
+
+export async function isInstalled(root, solution) {
+  const state = await readState(root);
+  if ((state.installed ?? []).includes(solution.id)) return true;
+  const primary = solution.files?.[0];
+  if (!primary) return false;
+  const target = path.join(root, 'src', primary.to);
+  return fs.existsSync(target);
+}
+
+export function solutionReadmePath(solution) {
+  return path.join(solution._dir, 'README.md');
+}

package/package.json

@@ -1,6 +1,48 @@
 {
   "name": "@effijs/templates",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0-alpha.1",
+  "description": "Forge presets and generators for EffiJS apps",
+  "type": "module",
+  "author": "Yevhenii Kyrychok",
+  "license": "MIT",
+  "exports": {
+    ".": "./forge.manifest.js",
+    "./presets/*": "./presets/*/index.js",
+    "./lib/*": "./lib/*.js",
+    "./platforms/*": "./platforms/*/platform.js",
+    "./forge.manifest.js": "./forge.manifest.js"
+  },
+  "files": [
+    "presets",
+    "lib",
+    "shared",
+    "platforms",
+    "docs",
+    "ai",
+    "forge.manifest.js",
+    "README.md",
+    "CONTRIBUTING.md"
+  ],
+  "scripts": {
+    "docs": "node lib/docs/build.js",
+    "docs:check": "node lib/docs/build.js --check",
+    "test": "node --test test/*.test.js"
+  },
+  "dependencies": {
+    "jsonc-parser": "^3.3.1",
+    "semver": "^7.7.2"
+  },
+  "peerDependencies": {
+    "@effijs/forge": "1.0.0-alpha.1"
+  },
+  "keywords": [
+    "forge",
+    "scaffolding",
+    "effijs",
+    "react-native",
+    "fsd"
+  ],
+  "engines": {
+    "node": ">=20.6.0"
+  }
+}

package/platforms/react-native/CATALOG.md

@@ -0,0 +1,391 @@
+<!-- GENERATED. Не редагувати вручну. Run `npm run docs` in @effijs/templates. -->
+
+# react-native catalog
+
+## Генератори
+
+### rn-fsd:setup
+
+Install EffiJS dependencies and patch React Native configs.
+
+Command: `forge g setup`
+
+Prompts: packageManager, navigator, moveStarter
+
+Flags: --package-manager, --navigator, --link-local <path>, --move-starter, --yes
+
+### rn-fsd:init
+
+Copy the FSD base: app shell, auth, profile, http, theme, and the base UI kit.
+
+Command: `forge g init`
+
+Prompts: apiUrl
+
+Flags: --api-url, --navigator, --yes
+
+### rn-fsd:demo
+
+Add product and category on top of init, including BottomSheet and Image.
+
+Command: `forge g demo`
+
+Prompts: none
+
+Flags: --yes
+
+### rn-fsd:entity
+
+Add an entity. crud matches product; simple matches category.
+
+Command: `forge g entity`
+
+Prompts: name, variant, apiUrl, fields
+
+Flags: --name, --variant crud|simple, --api-url, --fields title:string,price:number
+
+### rn-fsd:feature
+
+Add a feature and the screens you select. filter implies list. search still generates the list item.
+
+Command: `forge g feature`
+
+Prompts: name, entity, screens, tab
+
+Flags: --name, --entity, --screens all, --tab
+
+### rn-fsd:component
+
+Add a props-manager component: Common, pm, types, and index.
+
+Command: `forge g component`
+
+Prompts: name, base, extend, slots, location
+
+Flags: --name, --base View|Pressable|Text, --extend Box|Grid|Text|none, --slots container, --location ui
+
+### rn-fsd:add
+
+Install a catalog solution and its requirements.
+
+Command: `forge g add`
+
+Prompts: id
+
+Flags: --id component:BottomSheet
+
+### rn-fsd:util
+
+Install a utility. Same engine as add, filtered to type util.
+
+Command: `forge g util`
+
+Prompts: id
+
+Flags: --id util:permissions
+
+## Базовий набір (init)
+
+### Box
+
+- Type: component
+- Path: `ui/components/Box`
+- View with theme color, radius, and shadow props.
+
+### Grid
+
+- Type: component
+- Path: `ui/components/Grid`
+- Layout primitive with spacing and alignment props.
+
+### Text
+
+- Type: component
+- Path: `ui/components/Text`
+- Themed text with typography props.
+
+### Button
+
+- Type: component
+- Path: `ui/components/Button`
+- Pressable button. Loading uses ActivityIndicator.
+
+### Screen
+
+- Type: component
+- Path: `ui/components/Screen`
+- Screen shell with header, content, and safe area. Built for Wix navigation.
+
+### Form
+
+- Type: component
+- Path: `ui/components/Form`
+- EffiJS form bindings. DateTimePicker, SelectPicker, and InputSecurity are separate solutions.
+
+### TextInput
+
+- Type: component
+- Path: `ui/components/TextInput`
+- Themed text input. OTP is a separate solution.
+
+### Icon
+
+- Type: component
+- Path: `ui/components/Icon`
+- Icon font glyph.
+
+### Loading
+
+- Type: component
+- Path: `ui/components/Loading`
+- Loading overlay driven by a small store.
+
+### ThemePicker
+
+- Type: component
+- Path: `ui/components/ThemePicker`
+- Switches the active theme scheme.
+
+### toast
+
+- Type: widget
+- Path: `ui/widgets/toast`
+- Toast stack shown through navigation.widgets.showToast.
+
+### http
+
+- Type: service
+- Path: `services/http`
+- HTTP client with token and error middleware.
+
+### string
+
+- Type: util
+- Path: `utils/string.ts`
+- Text transforms used by form inputs.
+
+### date
+
+- Type: util
+- Path: `utils/date.ts`
+- Date helpers.
+
+### store.persistent
+
+- Type: util
+- Path: `utils/store.persistent.ts`
+- MMKV-backed persistent store.
+
+### auth
+
+- Type: entity
+- Path: `entity/auth`
+- Session, sign-in, and sign-up entity.
+
+### auth
+
+- Type: feature
+- Path: `feature/auth`
+- Sign-in and sign-up screens.
+
+### profile
+
+- Type: feature
+- Path: `feature/profile`
+- Profile screen and theme picker.
+
+## Компоненти
+
+### component:BottomSheet
+
+- Status: stable
+- Gesture-driven sheet with header and content slots.
+- Requires: none
+- npm: none
+- Command: `forge g add --id component:BottomSheet`
+- Manual: none
+- Guide: [solutions/components/BottomSheet/README.md](solutions/components/BottomSheet/README.md)
+
+### component:BottomSheetWidgets
+
+- Status: stable
+- List and date-time sheets, plus Form.Element.SelectPicker.
+- Requires: component:BottomSheet
+- npm: none
+- Command: `forge g add --id component:BottomSheetWidgets`
+- Manual: none
+- Guide: [solutions/components/BottomSheetWidgets/README.md](solutions/components/BottomSheetWidgets/README.md)
+
+### component:Calendar
+
+- Status: experimental
+- Calendar from the previous template kit. Treat the API as experimental until it is wired into a screen.
+- Requires: none
+- npm: none
+- Command: `forge g add --id component:Calendar`
+- Manual: none
+- Guide: [solutions/components/Calendar/README.md](solutions/components/Calendar/README.md)
+
+### component:Chart
+
+- Status: experimental
+- Chart from the previous template kit. Treat the API as experimental until it is wired into a screen.
+- Requires: none
+- npm: none
+- Command: `forge g add --id component:Chart`
+- Manual: none
+- Guide: [solutions/components/Chart/README.md](solutions/components/Chart/README.md)
+
+### component:CheckBox
+
+- Status: stable
+- Themed checkbox and the matching form element.
+- Requires: none
+- npm: none
+- Command: `forge g add --id component:CheckBox`
+- Manual: none
+- Guide: [solutions/components/CheckBox/README.md](solutions/components/CheckBox/README.md)
+
+### component:DateTimePicker
+
+- Status: stable
+- Form date field that opens the bottom-sheet picker.
+- Requires: component:BottomSheetWidgets
+- npm: none
+- Command: `forge g add --id component:DateTimePicker`
+- Manual: none
+- Guide: [solutions/components/DateTimePicker/README.md](solutions/components/DateTimePicker/README.md)
+
+### component:Image
+
+- Status: stable
+- Native and SVG image with theme sizing. SVG rendering uses Skia.
+- Requires: none
+- npm: @shopify/react-native-skia
+- Command: `forge g add --id component:Image`
+- Manual: none
+- Guide: [solutions/components/Image/README.md](solutions/components/Image/README.md)
+
+### component:InputSecurity
+
+- Status: experimental
+- Sanitize and validate text with the validator package.
+- Requires: none
+- npm: validator
+- Command: `forge g add --id component:InputSecurity`
+- Manual: none
+- Guide: [solutions/components/InputSecurity/README.md](solutions/components/InputSecurity/README.md)
+
+### component:OTP
+
+- Status: stable
+- One-time code field attached to TextInput.
+- Requires: none
+- npm: none
+- Command: `forge g add --id component:OTP`
+- Manual: none
+- Guide: [solutions/components/OTP/README.md](solutions/components/OTP/README.md)
+
+### component:ProgressIndicator
+
+- Status: stable
+- Linear and circular progress drawn with Skia.
+- Requires: none
+- npm: @shopify/react-native-skia
+- Command: `forge g add --id component:ProgressIndicator`
+- Manual: none
+- Guide: [solutions/components/ProgressIndicator/README.md](solutions/components/ProgressIndicator/README.md)
+
+### component:Ruler
+
+- Status: experimental
+- Ruler from the previous template kit. Treat the API as experimental until it is wired into a screen.
+- Requires: none
+- npm: none
+- Command: `forge g add --id component:Ruler`
+- Manual: none
+- Guide: [solutions/components/Ruler/README.md](solutions/components/Ruler/README.md)
+
+### component:Section
+
+- Status: stable
+- Segmented section control.
+- Requires: none
+- npm: none
+- Command: `forge g add --id component:Section`
+- Manual: none
+- Guide: [solutions/components/Section/README.md](solutions/components/Section/README.md)
+
+### component:Slider
+
+- Status: experimental
+- Slider from the previous template kit. Treat the API as experimental until it is wired into a screen.
+- Requires: none
+- npm: none
+- Command: `forge g add --id component:Slider`
+- Manual: none
+- Guide: [solutions/components/Slider/README.md](solutions/components/Slider/README.md)
+
+### component:Switch
+
+- Status: stable
+- Themed switch.
+- Requires: none
+- npm: none
+- Command: `forge g add --id component:Switch`
+- Manual: none
+- Guide: [solutions/components/Switch/README.md](solutions/components/Switch/README.md)
+
+## Сервіси
+
+### service:firebase-core
+
+- Status: stable
+- Resolves the default Firebase app.
+- Requires: none
+- npm: @react-native-firebase/app
+- Command: `forge g add --id service:firebase-core`
+- Manual: Download GoogleService-Info.plist and add it to the iOS app target. Download google-services.json and place it in android/app. Apply the Google services Gradle plugin in the Android build files.
+- Guide: [solutions/services/firebase-core/README.md](solutions/services/firebase-core/README.md)
+
+### service:firebase-messaging
+
+- Status: stable
+- Requests notification permission and reads the FCM token.
+- Requires: service:firebase-core, util:permissions
+- npm: @react-native-firebase/messaging
+- Command: `forge g add --id service:firebase-messaging`
+- Manual: Enable Cloud Messaging in the Firebase console. Upload the APNs authentication key for iOS. On iOS, enable the Push Notifications capability.
+- Guide: [solutions/services/firebase-messaging/README.md](solutions/services/firebase-messaging/README.md)
+
+## Утиліти
+
+### util:permissions
+
+- Status: stable
+- Asks for notification permission on iOS and Android.
+- Requires: none
+- npm: none
+- Command: `forge g util --id util:permissions`
+- Manual: none
+- Guide: [solutions/utils/permissions/README.md](solutions/utils/permissions/README.md)
+
+### util:date
+
+- Status: stable
+- Pure date helpers. init already copies this file for React Native.
+- Requires: none
+- npm: none
+- Command: `forge g util --id util:date`
+- Manual: none
+- Guide: [../../shared/solutions/utils/date/README.md](../../shared/solutions/utils/date/README.md)
+
+### util:string
+
+- Status: stable
+- Pure string transforms. init already copies this file for React Native.
+- Requires: none
+- npm: none
+- Command: `forge g util --id util:string`
+- Manual: none
+- Guide: [../../shared/solutions/utils/string/README.md](../../shared/solutions/utils/string/README.md)